存档日期:2017年2月27日 | 首次发布:2002年8月1日
Java语言通过Javadoc注释约定对API文档采用了集成方法。 Javadoc工具可以帮助生成漂亮的API文档,但是绝大多数Java API文档简直糟透了。 因为它是源代码的一部分,所以API的文档编制责任完全由工程师承担。 在本文中,Brian讲述了Java文档实践的当前状态,并提供了一些有关如何编写更有用的Javadoc的指南。
此内容不再被更新或维护。 全文以PDF格式“按原样”提供。 随着技术的飞速发展,某些步骤和插图可能已更改。
查看PDF文件
翻译自: https://www.ibm.com/developerworks/java/library/j-jtp0821/index.html
相关资源:北大自考上机java实践