作为一般规则,我使用与代码相同的DRY(不重复自己)原理:
- 在界面上,记录界面
- 在实施过程中,记录实施细节
特定于Java的 文档:在记录实现时,请使用{@inheritDoc}标记从界面“包括” javadocs。
想要查询更多的信息:
- 官方JavaDoc文档
- 一些非正式的建议。
欢迎分享,转载请注明来源:内存溢出
作为一般规则,我使用与代码相同的DRY(不重复自己)原理:
特定于Java的 文档:在记录实现时,请使用{@inheritDoc}标记从界面“包括” javadocs。
想要查询更多的信息:
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)