求问在Eclipse Help 中如何组织 Java API 参考文档

发布网友发布时间：2022-05-17 10:51

共1个回答

热心网友时间：2023-10-19 12:33

背景提高产品文档的可使用性是许多项目成功的关键。项目的成功直接归因于您生成并书写优秀文档的工作。本材料假设您熟悉 Java 软件、Java API 参考文档结构、Javadoc 生成，并且想要了解更多关于如何提供改进的 Java API 参考文档的信息。
对于初学者，您应该了解下面这些内容： Javadoc，Sun Microsystems 创建的开源工具。要了解更多信息，请阅读 java.sun.com/j2se/javadoc。 JavaHelp，拥有索引和搜索能力的帮助集。要了解更多信息，请参见 java.sun.com/procts/javahelp。 Java Help 的编写工具。要了解更多信息，参考 java.sun.com/procts/javahelp/instry.html 上的列表。 Standard Java Coding Conventions。要了解详细情况，请参见 java.sun.com/docs/codeconv 和快速参考单。 Javadoc Conventions。