我现在码着代码 就像是一台机器

2015-07-24 14:00:27 +08:00
 unique

公司开发了一年多的代码,代码行数14W+
换了领导后突然说要给代码都加上注释,刚来公司的时候没有这个规定。
当时也写了注释,但不是很规范,现在要求在一个月的时间里让我一个人写完所有注释。
现在码着这些注释的我就像是一台机器努力运行着,心里当然有些委屈。
我怎么能摊上这种事儿呢,也是醉了。。公司不大,要求蛮多,不知道其他同事是如果,反正开发部我的机械键盘噼里啪啦的响个不停,我越听越来气。

7039 次点击
所在节点    程序员
84 条回复
swolf119
2015-07-24 23:43:14 +08:00
为什么会觉得写注释不可理解?
这种东西就应该在最初coding的时候注好,不要给我讲任务紧哪有时间以后再加
later equals never
好习惯都是慢慢养成的
mornlight
2015-07-25 01:26:06 +08:00
投入 iOS 开发的怀抱吧!需要的注释非常少
arkilis
2015-07-25 06:28:25 +08:00
你自己写一段脚本添加注释
hanxi
2015-07-25 07:43:52 +08:00
写这么多,真成一台机器了。要时刻保持代码精简易懂。
wecan
2015-07-25 08:17:45 +08:00
repeat
i:=i+1;
until i=i+1;
miniwade514
2015-07-25 09:28:07 +08:00
很多人都在讨论“写注释”本身。。。
楼主不爽的不是写注释,而是老板让你做的这件事情 —— 擦屁股。
14W+ 行的代码,真正经常会需要被人阅读和修改的有多少?换言之,真的有必要现在去加注释的有多少?一句话就让你把**所有**老代码都加上注释,必然是不合理的。
更合适的办法可能是:
1. 找一个最熟悉这些代码的人,评估一下,找出其中最最需要加上注释的代码,补上注释。所以,首先我们认可注释的重要性。
2. 叫上团队里最有经验的几个开发,一起商讨制定代码规范,以及如何落实。在将来所有新写的代码里,遵守这个规范。
以上是我个人的看法,肯定比较局限。但是感觉还是比你现在做的事情更有性价比。
sobigfish
2015-07-25 09:34:16 +08:00
全是lz自己的代码的话不是你加还能找别人加?
真要注释的加上,其他的写个shell用模板批量生成怎么样?
有些注释可能只是为了方便生成文档
cxshun
2015-07-25 10:00:37 +08:00
别人的代码也要你加?如果是,这领导也是牛到不行啊。
我觉得这种没必要真的全部加上,简单的就不用写了,复杂逻辑加一些还是有必要的。
fuxiaohei
2015-07-25 10:09:58 +08:00
擦屁股的事情,慢慢磨
loading
2015-07-25 10:13:00 +08:00
这就叫码农!“农”是“虫族农民”的“农”~

只是把别人(就那只提要求的狗)提的要求写成代码的民工,就是楼主这种状态。
我听说很多低收入的java民工就是这类机器人!
aivier
2015-07-25 10:37:06 +08:00
领导可以放心,让我写一堆注释的话那下一任就别妄想看懂代码了 =_=
zhujinliang
2015-07-25 10:40:15 +08:00
搞个自动注释机
自动爬AST,产生相应的中文描述
自动Google Translate,把英文名词翻译为中文


int main() { // 主函数
for (int i = 0; i < 5; i++) { // 循环5次
print("hello world"); // 打印 "你好世界"
}
}
bdnet
2015-07-25 10:53:53 +08:00
这岂不是“为了注释而注释”

要求写注释没错,但这种集中式的盲羊补牢,也要考虑程序猿的感受吧
Draplater
2015-07-25 11:32:29 +08:00
自动注释敷衍过去
azhao
2015-07-25 11:45:10 +08:00
代码本来就是要写注释的
我很久前我去一个从来没有去过的客户现场
用户那边人对我说:唉呀,你在我们这里老有名了,终于见到你了
我问怎么我就有名了
我们在代码里老看到你的名字

瞬间也觉得这瞒有逼格的,但关键是,你写的代码质量要不错
kn007
2015-07-25 11:48:52 +08:00
拖字诀。。一个月搞不定,还真能把你怎么滴。
Navee
2015-07-25 13:47:01 +08:00
这也只是个形式而已,我不信真有人来检查你的注释。以前公司有个小组开发了一个组件,虽然在初版的时候以领导的要求做了完整的注释生成了一份doc,作为组件使用者,这份文档根本没有什么卵用
ruandao
2015-07-25 14:09:15 +08:00
我觉得,你搞错了
添加注释也是工作的内容,工作内容自然是上班时间去完成,不是说个人额外花时间,个人的时间应该花在提升自己上,除非说老板一开始让你加注释,你非不加,然后...
ruandao
2015-07-25 14:14:48 +08:00
抱歉,我内容看错了

不过,反正上班时间加注释
zz
2015-07-25 15:02:32 +08:00
厉害!

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://tanronggui.xyz/t/208039

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX