chapter2_homework1
·文档注释(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释。(减少程序猿工作量)
·区别于普通注释/*……*/,文档注释使用/**……*/ 。
·文档注释一般包括描述部分和标记部分。
·描述部分,任意自然语言
·标记部分,@常见标记
(详见文章底部链接)
海风:
本章介绍了Java的文档注释,
要求对附件中提供的示例程序
DocTest.java
,独立运行
javadoc
命令得到完整的文档注释。
注意:码云仓库中提供的测试用例与讲义中有所不同,多了第一行的包声明语句,需要同学们进一步自学后对讲义提供的javadoc命令稍作修改。
DocTest.java如下
在cmd中,DocTest.java文件夹路径下,使用javadoc命令生成注释文档
eg: javadoc DocTest.java
·又,注释文档第一行有包声明,且为避免网页乱码,使用 -packages, -encoding UTF-8 参数
eg: javadoc -package -encoding UTF-8 DocTest.java
·生成的文件夹如下
·打开index.html文件
以上。
参考链接: