相关疑难解决方法(0)

Javadoc @author标记了良好实践

我想知道创建Javadocs时的最佳实践.我有一个包含许多文件的项目.代码已由许多开发人员创建.每个文件都有一个注释@author,因此很明显谁创建了一个特定的类.

但是当其他开发人员向文件添加新代码,修改它等等时,他应该如何通知团队的其他成员他已经创建了一些新功能或修改了现有代码?换句话说,我们应该如何"让Javadocs与现实保持一致"?;)

  • 将他的名字添加到现有@author标签?然后,如果有任何疑问,更容易识别要询问的人.
  • @author为每个新方法,内部类等添加标记?

当然,由于我们使用SVN,很容易调查谁做了什么,但为了保持清楚,这个Javadoc的东西也应该被考虑在内.

使用这些@author标签的最佳方法是什么?

java javadoc author

57
推荐指数
6
解决办法
6万
查看次数

jshint - 创建自定义警告/规则

是否可以创建自定义jshint规则,将其添加到现有的内置规则,在我们的项目中配置(打开还是关闭)?

jshint是否可扩展,就像我们如何在Grunt中创建自己的自定义任务一样?

有时我们需要在我们的环境中强制执行javascript编码实践.例如,我们希望强制我们的开发人员使用Date.now()而不是Date.getTime().

javascript jshint

10
推荐指数
1
解决办法
3717
查看次数

标签 统计

author ×1

java ×1

javadoc ×1

javascript ×1

jshint ×1