码迷,mamicode.com
首页 > 其他好文 > 详细

文档注释与多行注释的区别

时间:2017-01-07 00:39:41      阅读:284      评论:0      收藏:0      [点我收藏+]

标签:class   生成   log   需要   blog   ado   文件   span   路径   


多行注释与文档注释的区别: 多行注释的内容不能用于生成一个开发者文档,
而文档注释 的内容可以生产一个开发者文档。


使用javadoc开发工具即可生成一个开发者文档。
    
    javadoc工具的使用格式:
        
        javadoc -d 存放文档的路径   java的源文件 
    

使用javadoc工具要注意细节:
    1. 如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰。
    2. 文档注释注释的内容一般都是位于类或者方法的上面的。

写注释的规范:一般单行注释是位于代码的右侧,多行注释与文档注释一般是写在类或者方法的上面的。

 

文档注释与多行注释的区别

标签:class   生成   log   需要   blog   ado   文件   span   路径   

原文地址:http://www.cnblogs.com/xufengyuan/p/6257917.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!