在 Eclipse Help 中如何组织 Java API 参考文档
来源:百度文库 编辑:神马文学网 时间:2024/04/26 00:01:29
本文介绍了生成易用且可供搜索的 Java 应用程序编程接口(Java application programming interfaces,API)的参考文档的不同方法。
提高产品文档的可使用性是许多项目成功的关键。项目的成功直接归因于您生成并书写优秀文档的工作。
本材料假设您熟悉 Java 软件、Java API 参考文档结构、Javadoc 生成,并且想要了解更多关于如何提供改进的 Java API 参考文档的信息。
对于初学者,您应该了解下面这些内容:
Javadoc,Sun Microsystems 创建的开源工具。要了解更多信息,请阅读java.sun.com/j2se/javadoc。 JavaHelp,拥有索引和搜索能力的帮助集。要了解更多信息,请参见java.sun.com/products/javahelp。 Java Help 的编写工具。要了解更多信息,参考java.sun.com/products/javahelp/industry.html 上的列表。 Standard Java Coding Conventions。要了解详细情况,请参见java.sun.com/docs/codeconv 和快速参考单。 Javadoc Conventions。要了解详细情况,请参见java.sun.com/j2se/javadoc/writingdoccomments。
提高产品文档的可使用性是许多项目成功的关键。项目的成功直接归因于您生成并书写优秀文档的工作。
本材料假设您熟悉 Java 软件、Java API 参考文档结构、Javadoc 生成,并且想要了解更多关于如何提供改进的 Java API 参考文档的信息。
对于初学者,您应该了解下面这些内容:
Javadoc,Sun Microsystems 创建的开源工具。要了解更多信息,请阅读java.sun.com/j2se/javadoc。 JavaHelp,拥有索引和搜索能力的帮助集。要了解更多信息,请参见java.sun.com/products/javahelp。 Java Help 的编写工具。要了解更多信息,参考java.sun.com/products/javahelp/industry.html 上的列表。 Standard Java Coding Conventions。要了解详细情况,请参见java.sun.com/docs/codeconv 和快速参考单。 Javadoc Conventions。要了解详细情况,请参见java.sun.com/j2se/javadoc/writingdoccomments。
在 Eclipse Help 中如何组织 Java API 参考文档
Java深入:在Eclipse中如何利用Maven_Java教程_www.knowsky....
在 Eclipse 中运行带参数的 Java 程序
如何在eclipse中配置nutch
Eclipse插件之Spring IDE - Java文档中心 - Java - Chin...
如何在word文档中添加目录
如何在Java中调用dll
Matrix - 与 Java 共舞 - 教程-在Eclipse中使用Hibernate
Matrix - 与 Java 共舞 - 教程-在Eclipse中使用Hibernate
在eclipse下使用java调用weka
JDK?API文档中,、、>分别代表什么意思?
如何在word文档中加进参考文献的标注?
如何在MFC单文档中创建多视图-GOOD
特别推荐:如何在记事本中做到文档段首空二格
在 Eclipse 中利用 Maven
在 Eclipse 中利用 Maven
在Eclipse中使用CVS
在Eclipse中使用Hibernate
在Eclipse中使用Hibernate
在 Eclipse 中利用 Maven
java中如何对一个double变量在十位数四舍五入?
在java如何判断字符串有多少中文字?
Java XML API 漫谈
Java Transaction API概述