注释的三种类型:
1.单行注释(双斜线)//
2.多行注释(一次性将程序的多行注释掉)/*...*/
3.文档注释:如果编写Java源代码是添加了合适的文档注释,然年后通过JDK提供的Javadoc工具可以直接将源代码里面的文档注释提取成一份系统的API文档
文档注释适用于生成API文档的,javadoc工具只处理Public和protect*(两者是开发者想要暴露的内容,private私有)修饰的类、接口、方法、filed、构造器、和内部类之间的注释,忽略其他地方的文档注释.
复制代码
eclipse中注释快捷格式:
eclipse下:(ALT+Shift+J:快速文档注释;也可快速方法注释)
Windows cmd下:cd dirctory1//进入dirctory1目录下
dir//查看当前目录下的文档
复制代码
Javadoc命令示范:
命令1:javadoc -d dir1 -windowtitle name1 -doctitle name2 -header name3 -version -author *a.java
// 表示将当前目录下的形如.a.java的java文件生成api文档并存放于当前目录下,名为dir1.
命令2:javadoc -d apiDoc -windowtitle API -doctitle Study -header MyClass -version -author test test2
//表示将当前目录下的test包和test2包生成api文档并存放于当前目录下,名为apiDoc.\
参数介绍:
-d :(name1)后表示指定一个路径ÿ