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

[unique]

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

[unique]

@AmberBlack 简直在摧残生命ing

[AmberBlack]

@unique 我最近撸代码撸多了，腱鞘炎了都出来了。楼主慢慢来。

[nisnaker]

写完注释就会让你卷铺盖了。

[dai269619118]

反正我肯定不会这么干 除非工资高到我舍不得走的程度

[zythum]

一般规范或者规定都是发布之后的才遵守的。比如发布规定以后写函数都要有注视。那也没有让你吧之前的函数都加上注释的啊。 就好比办法醉酒驾驶吊销执照，总不能把之前醉酒驾驶的都去吊销一遍吧。

要是下个领导表示要把空格锁进改成table....

[unique]

@nisnaker 如果是这样还好，省的想走又被留

[fengyqf]

int i; //定义整形变量i
i++; //变量i递增1
....

[unique]

@fengyqf 没有这么夸张，但是源代码的量和文件着实的多，团队写还好，我一个人实在难消化

[ren2881971]

写个小脚本。 先自己定义一个 注释字典。 然后随机把这些注释加在 每个某文件的 某行下。。。

[ren2881971]

这么做是不是有点坑 下一个维护你代码的人。。 匿了、

[jings]

每月一万 注完你也是大神了

[hitmanx]

估计是让每个函数都加上类似风格的说明吧。我个人觉得这种东西尽管很规范，其实意义不大的。。关键地方加几行说明就行了，这种有点形式主义

/**
* Return the xxx instance configured for xxx
* @param xxx
* @param xxx
* @return xxx, if configured
* NULL if not configured
*/

[lucifer9]

趁还能看得懂赶紧写吧...

[laucie]

不写注释是不对的 也怪当初那位领导

[delavior]

一曲美妙的音乐。。。

[yxjxx]

摸摸头~

[dorentus]

话说 Google 的编码规范里面一般会有一条，讲如何处理不满足规范的旧代码的，比如这个： https://google-styleguide.googlecode.com/svn/trunk/cppguide.html#Existing_Non-conformant_Code

You may diverge from the rules when dealing with code that does not conform to this style guide.

If you find yourself modifying code that was written to specifications other than those presented by this guide, you may have to diverge from these rules in order to stay consistent with the local conventions in that code. If you are in doubt about how to do this, ask the original author or the person currently responsible for the code. Remember that consistency includes local consistency, too.

----
这上面还是说的是在修改这些代码的时候，可以不完全考虑规范。

而目前能用且没有需要改动或重构的代码，根本就不应该去碰好么……与其做加注释这种事情，还不如直接重构/重写掉，在重写的代码上应用新的规范。

----
对公司来说，员工利用工作时间来做加注释这种事情也是没有任何产出的亏本行为
也就是不计效率的或是压榨员工的公司才会搞这种事吧

[l1905]

换个思路(自我安慰) 加注释的同时。。又熟悉了一遍 代码逻辑

[unique]

@yxjxx 土豪

[tuoxie007]

给别人的代码写注释。。。亏你们公司能想得出来