我想知道创建Javadoc时的最佳实践。我有一个包含许多文件的项目。许多开发人员已经创建了代码。每个文件都有一个注释@author
,因此很明显是谁创建了一个特定的类。
但是,当其他开发人员向文件添加新代码、修改它等时,他应该如何通知团队的其他成员他已经创建了一些新函数或修改了现有代码?换句话说,我们应该如何“保持Javadoc与现实的兼容性”?;)
@author
标签中?这样,如果有任何疑问,就更容易确定该问谁了。@author
标记。?当然,因为我们使用SVN,所以很容易调查谁做了什么,但为了保持清晰,也应该考虑Javadoc的东西。
使用这些@author
标记的最佳方式是什么?
https://stackoverflow.com/questions/17269843
复制相似问题