查看: 4811| 回复: 20
跳转到指定楼层
上一主题 下一主题
收起左侧

[新组上路] 文档支零破碎代码几乎没有注释是大厂常态吗

🔗
匿名用户-H5XGO  | 添加认证 | 2022-8-15 08:14:39 |倒序浏览

注册一亩三分地论坛,查看更多干货!

您需要 登录 才可以下载或查看附件。没有帐号?注册账号

x
本帖最后由 匿名 于 2022-8-14 17:17 编辑 . 1point3acres

新加入某大厂某产品组。
1)设计文档基本没有,只能从历史讲座/汇报中找到一些slides拼凑起了大概程序框架。问老人说是infra这块已经很久没怎么大改过了,业务逻辑啥的都是N年前定稿,偶尔有些修补,现在组里面也基本都不熟悉了。.google  и
2)读代码发现只在重要的接口函数/基类里面有一些注释,派生类中具体的函数实现几乎没有注释(最近1-2年的代码),一看check-in都是小年轻(没有歧视的意思),感觉没有好好受过代码规范的培训/指导,或者是赶工赶时间导致没有注释(if——else 扎堆嵌套什么的都不算事)。
3)自己身上找原因,有可能是自己业务不熟,不太了解context所以看代码理解业务逻辑有点费劲。
因为只在一家大厂待过,不知道这是不是通病。

上一篇:在产品组抱怨XFN和metrics的纯属无病呻吟
下一篇:Amazon的software development engineer和software engineer之间有什么区别?
全局:
理念:不鼓励写注释,代码要清晰明确,代码本身就是注释。

执行:我们这儿代码不需要注释!
回复

使用道具 举报

全局:
认真讲 如果楼主研读过clean code这本书,书里是不建议加注释的。代码本身从变量名到各种命名,都应该是self explanary。每一个method just does one thing。
回复

使用道具 举报

全局:
我最恨两种码农,一种是代码不加注释的,另一种是非让我加注释的。
回复

使用道具 举报

全局:
林子大了 什么鸟都有。大厂未必就都规范。😄
回复

使用道具 举报

地里匿名用户
🔗
匿名用户-XDMJO  | 添加认证 | 2022-8-15 08:24:27 来自APP
是的,因为原始文档只有最初的设计,后续小改都不会有完整的文档,绝大多数公司不存在有人当雷锋给你定期更新设计架构的文档。
回复

使用道具 举报

地里匿名用户
🔗
匿名用户-GFXYO  | 添加认证 | 2022-8-15 08:56:23
大小厂在这点上基本都是一样的。大部分程序员天生不爱写文档,想要文档好,得招专职的写文档的岗位。
回复

使用道具 举报

全局:
我们又不是烦跟别人align的xfn,那种有什么好烦的. Waral dи,

补充内容 (2022-08-15 13:15 +08:00):
这是个bug?我是回复另外一个帖子的….请大家忽略我
回复

使用道具 举报

全局:
大厂代码确实不怎么加注释,因为本身规范就要求你的函数变量便于理解,你看函数名和变量名就知道要干嘛,注释一般在比较复杂或者特殊的逻辑
回复

使用道具 举报

地里匿名用户
🔗
匿名用户-H5XGO  | 添加认证 | 2022-8-15 12:31:04 来自APP
柯基101 发表于 2022-08-14 21:16:40
大厂代码确实不怎么加注释,因为本身规范就要求你的函数变量便于理解,你看函数名和变量名就知道要干嘛,注释一般在比较复杂或者特殊的逻辑
就是看完函数命名依旧不清楚是要干什么的,尤其是什么generate,create,controller,factory套着娃出现
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 注册账号
职场达人
  • ↑ 本版用于讨论职场各种干货话题,闲聊请去🔗聊聊或者🔗匿名版
  • ❌ 本版严禁水贴,引战,发布广告,拉群,贴个人联系方式,扣分无警告
  • ☑ 求职、面经等去 🔗北美求职和 🔗回国求职大区,刷题和学习请去 🔗终身学习大区
  • ☑ 请去专版发布 🔗内推, 🔗招聘信息,和讨论 🔗创业内容
  • ☑ PIP / DevList/ Need Support 等话题也已开设 🔗专版

本版积分规则

>
快速回复 返回顶部 返回列表