发现同事们很喜欢写这样的代码注释...

2014-04-03 10:11:35 +08:00
 gangsta
//************* xxx function START *************//

code block...

//************* xxx function END *************//

还有一个是维护类代码的注释,在我待过的公司,以及被外派,出差,各种onsite/offshore合作过的公司中,同样发现很多人都喜欢这么写...

先把bug代码块注释掉,然后...

//************* modified by xxx at 2013-02-14 for xxx reason START *************//

code block...

//************* modified by xxx at 2013-02-14 for xxx reason END *************//
9960 次点击
所在节点    程序员
53 条回复
cashplk
2014-04-03 20:29:17 +08:00
以前呆过一个公司,他们要求就是这样的。符合规则就好。好坏勿论。
wwek
2014-04-03 22:00:26 +08:00
冗余点的注释 没关系。只要不是产生混淆的注释。

那种没注释的才是真坑爹·
lidonghao
2014-04-03 22:06:43 +08:00
modified by xxx @ V1.x.x
在最上方写版本的相关信息
loryyang
2014-04-03 22:47:00 +08:00
我遵守:无用代码就删掉的原则。因为无用代码包括注释会对其他接收人造成混淆和精神负担。一个是看着实在是费劲,我看过连续上百行被注释掉的代码,实在是崩溃了。有了版本管理器之后,删掉的代码完全可以删掉了。另外一个是可能会造成混淆,注释什么的如果需要,就要跟着代码的修改而不断升级,否则慢慢的,注释就废掉了,变成一种无用的负担。
所以建议是少加注释,无用代码全删,代码尽量自解释,命名要长,逻辑尽量简单。复杂的内容才加注释
likuku
2014-04-04 00:32:41 +08:00
不是任何地方都有版本管理,很多时候可能需要直接面对服务器操作,可能还没带自己工作电脑,哪里去搞版本库?直接写源码里最方便了。
kneep
2014-04-04 08:12:46 +08:00
最烦这种到此一游的注释了,水平差的人基本都不知道有blame,水平差的人也不信任git或svn能做得更好,他们除了checkout和chechin,啥都不会,这样的人充斥了各个公司。
Debiancc
2014-04-04 09:29:30 +08:00
//声明 变量fuck
var fuck={};
azhao
2014-04-04 23:18:48 +08:00
写法可以更简洁一些,但写是有必要的,很多人改代码的时候可不会去看你的svn log才会改
poke707
2014-04-06 17:13:41 +08:00
这也是解决问题一种办法,可能是历史原因导致不能做得更好。所以在我们非当事人或者是全新开始的话,看起来有点挫
entertainyou
2014-04-06 21:49:31 +08:00
@bengol bream modify
smilerhaha
2014-04-07 10:50:47 +08:00
支持 @wdlth的写法
leavic
2014-04-07 15:47:00 +08:00
我以前也喜欢写XXX Start,XXX End,
不过现在比较少了,函数名写清楚点什么事都没了.
lygmqkl
2014-04-07 17:50:15 +08:00
bug资料写入代码。。。 那么version control 的角色在哪里? 一个月更新2次,或者说3个月后相同功能就砍了,那么在这类代码的投入是不是太铺张了,或许写 win ios这样的系统需要这样吧。一般项目觉得没必要。

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

https://www.v2ex.com/t/107065

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

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

© 2021 V2EX