这不有是Java的,但它是什么我处理.此外,与其关注的方法和细节,我不知道整体类文件.
在我对给定类文件的评论中,我真正需要做些什么？在我的公司,我真正能想到的唯一的东西:
还有什么应该提供的吗？
我听到的一个合乎逻辑的事情是让作者不在标题之内,因为它已经通过源代码控制提供的信息是多余的.
更新: JavaDoc可以在这里假设,但我真的更关心包含内容的好处的细节,是否可以挖掘的权威元数据,或者更松散,为什么等...
dfa*_*dfa 14
我听到的一个合乎逻辑的事情是让作者不在标题之内,因为它已经通过源代码控制提供的信息是多余的.
最后修改日期也是多余的
我使用了一小组文档模式:
否到"最后修改日期" - 也属于源代码管理.
另外两个很好.基本上专注于有用的文本 - 类的功能,任何关于线程安全,预期使用等的警告.
实施意见通常应该是关于你为什么做一些非显而易见的事情 - 因此应该很少见.(例如,它可能是因为某些API以不寻常的方式运行,或者因为您可以使用有用的快捷方式,但这并不是很明显.)
| 归档时间： |
|
| 查看次数： |
4956 次 |
| 最近记录： |