朙的学习笔记

生活、学习、工作
posts - 12, comments - 11, trackbacks - 0, articles - 0
  BlogJava :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理

JavaDOC文档注释规则

Posted on 2009-04-24 09:43 zengmingcd@163.com 阅读(598) 评论(2)  编辑  收藏 所属分类: 学习ing

        在代码中加入注释是非常好的编程习惯。
        在Java中提供了JavaDOC用于生成类、方法的说明文档。可以通过该文档轻松说明类、方法的作用、参数、返回等信息。

        JavaDOC的注释规则如下:

        (1) 文档注释置于将要注释的类或方法定义之前。

        (2) 专有注释定界符/** 开头。

        (3) 第一行描述该方法的目的。

        (4) 对每个参数进行注释。每行以@param开始,此后是参数名和简要说明。

        (5) 最后一行描述该方法的返回值。以@return开始。

        (6) 最后以*/结束。

        例如:

1/**
2*    这个方法要完成……
3*    @param name 参数意义
4*    @return 最后要返回一个什么什么的
5*/

6

——摘自BIG JAVA

        当然JavaDOC的功能还不止这些。
        @后面还有很多参数。等下次再研究研究。



Ming
E-Mail:zengmingcd@163.com


评论

# re: JavaDOC文档注释规则  回复  更多评论   

2009-04-24 10:55 by 重庆理工小子
可以参考:
http://www.blogjava.net/balajinima/articles/173665.html
http://blog.csdn.net/afeilxc/archive/2009/04/09/4060089.aspx

# re: JavaDOC文档注释规则  回复  更多评论   

2009-04-27 11:04 by zengmingcd@163.com
@重庆理工小子
恩,很详细。谢谢。

只有注册用户登录后才能发表评论。


网站导航: