Java 文档 JavaDoc 的写法

好的程序员是会写文档的程序员，为自己写，也为别人写。
有句话说的好：好的代码是别人能够看懂的代码
文档也在交流中起了非常重要的作用。

你为你的 java 程序写文档乐吗？你知道怎么写 java 文档吗？


JavaDoc 是 java 程序员写文档的标准
javadoc 也是一条命令，可以从你的代码里的文档自动生成 类似 java api document 的文档
其实整个 java api doc 就是用 javadoc 生成的：


下文是两个有关 javadoc 的简单介绍：

javadoc，在 Java 的注释上做文章
http://outinn.myrice.com/book/javadoc/

JavaDoc
http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/javadoc/javadoc.html


另外请参考：

Code Conversion: SUN 推荐的书写 Java 程序的格式和规范 
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html 
包括如何命名（文件，类，方法），各种语句的格式，文档的写法。。。 

Java Coding Style Guide 
ftp://cinc.3322.org/pub/doc/java/CodingStandard/java-style.pdf

Javadoc真的很好用，相信现在的Java工程项目，都用javadoc生成文档吧，我下载的一些开源项目也是用javadoc的。