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

[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 *************//

[slixurd]

xxx modify没啥必要，但是修改原因还是很有意义的
函数顶部外加doc型注释，说清楚参数含义，调用方式
我是没见过几个人看源代码开着git blame来看的，又没高亮又不方便跳转
用来差错定位是谁改错用git blame还差不多

[viator42]

这种注释方式很好用.
尤其是在行数很多的文件里分隔不同的功能模块,看起来一目了然.
做版本管理的话太原始了.
以前还有必须是80个字符的规定.

[ichou]

html 和 css 里面才用这种 start end 的注释
其他的都严格按照 DOC 来写
我会说我曾经在自己写的类注释里面还画了一个 逻辑流程图示 么？小伙伴看到那个注释可带劲儿了

[parthenon2007]

知足吧，这已经很好了，至少还可以看出来以前是因为什么原因修改了代码。何况有时也无法连接到版控。

[emanonwzy]

我待的第一家公司也是这样，据说是为了出bug可以找到修改的人。。。

[xiaowangge]

昨天刚接触到的: package-info.java

,-)

[loading]

html喜欢用start和end

[lu18887]

@raincious 看公司把，互联网公司用GIT的可能性大一些，传统的都还是SVN。

[tonic]

@lu18887 svn不也是命令敲么... svn co, svn ci -m, svn sw --force, svn merge...

[lu18887]

@tonic 但我从来没用命令行的svn看过log ……

[raincious]

@lu18887

其实是历史原因哈。不过另外SVN有一个巨大的好处，就是你想要commit，必须commit到服务器上，这样大家都能看到，不会有本地堆积了一堆commit之后，push时的冲突。

[caizeng]

我觉得这是一个好习惯

[janxin]

以前学VC和VB的时候，挺常见的...

[Livid]

最好不要在线上的代码里留注释掉的代码。这个东西就是读代码的人的精神负担和改代码的人的定时炸弹。

这些代码应该加一个容易搜索的关键字留在版本控制历史里。

[hkongm]

多好的习惯啊。
如果没有版本管理这样是最好的了。
还有上面有的同学说版本管理，有几个人认真填写commit comment的？我认识的，除了我一个人，没人认真写。。。

[tonic]

@lu18887 不过也是... 因为太难看了= =#

[lightening]

我们公司的代码规范说无特殊情况禁止写注释…… 如果你的代码要注释才能看懂，说明代码写坏了，回去重构。另外说明性质的语句放在 git commit message 里供人 blame 看。

[jsonline]

If you see such comments in someone's code, it may imply that
1. the function is bloated.
2. he takes no advantage of SVN or GIT

[icyalala]

1.代码是给人看的，总有某段代码不容易被理解，加上注释会更友好、理解更迅速。
不加注释能不能看懂是另外一回事了。
2.modified by xxx at xxx这种。。只能说版本控制没用好。

[wuxqing]

modified by xxx at xxx
这种没啥问题，有的时候代码不是本部门维护，可能会有第三方。版本管理不一定好使