Cam*_*ron 13 language-agnostic comments
我有很多用各种语言编写的源代码文件,但没有一个在顶部有标准注释(有时甚至在同一个项目中).其中一些根本没有任何标题评论:-)
我一直在考虑创建一个标准模板,我可以在源文件的顶部使用,并且想知道我应该包含哪些字段.
我知道我想要包含我的名字和文件包含/做的简短描述.我还应该包括创建的日期吗？上次修改日期？上次修改文件的程序员？你发现哪些其他领域有用？
任何提示和评论欢迎.
谢谢,
卡梅隆
Nei*_*l N 17
这似乎是一种垂死的做法.
StackOverflow上的一些人完全反对代码注释(推断代码应该写成自我解释)虽然我不会走得那么远,反评论人群的一些观点是有道理的,比如评论这一事实往往过时了.
评论标题块更容易受到这些症状的影响.我所在的每个组织都有这些标题块,它们已经过时了.他们有一个作家的名字甚至不在那里工作,一个完全不符合代码的描述(假设曾经做过)和最后修改日期,曾经与版本控制历史相比,似乎错过了它的最后十几个更新.
在我个人看来,请保持评论接近代码.如果您想了解代码文件的用途和/或历史记录,请使用您的版本控制系统.
创建日期,修改日期和上次更改文件的作者应存储在源代码管理软件中.
我经常说: