单行注释、多行注释、文档注释最完美的解释、导出API

注释是程序开发人员和程序阅读者之间交流的手段,对代码的解释和说明,提高软件的可读性,有利于程序应用的维护。

1、单行注释

只对一行代码注释,例如 //单行注释,以‘//’开头,跟在‘//’后面的文本就是注释内容。单行注释不会被编译,不要把代码写在‘//’的后面。

快捷键:ctrl+/

2、多行注释

当多行内容要被注释时,选择多行注释。例如 /多行注释/

快捷键:选中要注释的内容,按ctrl+shift+/ ,也可以输入 /* 后按enter键即可。

3、多行注释

格式:/**

 * 走路方法

*/

快捷键:在myeclipse的类中的内容顶部输入 /** 后按enter键即可。

如果想导出帮助文档API文件,那么就可以在方法或类的前面使用文档注释,使用安装jdk的javadoc命令把代码文档注释的部分提取出来,自动生成HTML格式的API帮助文档。可以使用myeclipse导出整个项目的帮助文档,也可以导出单个类或接口的API。文档注释还有一个好处是被调用的方法,当鼠标移到上面时提醒注释内容。

常用的文档注释标签

语法 作用 示例
@author 标识一个类的作者 @author description
@deprecated 指名一个过期的类或成员 @deprecated description
{@docRoot} 指明当前文档根目录的路径 Directory Path
@exception 标志一个类抛出的异常 @exception exception-name explanation
{@inheritDoc} 从直接父类继承的注释 Inherits a comment from the immediate surperclass.
{@link} 插入一个到另一个主题的链接 {@link name text}
{@linkplain} 插入一个到另一个主题的链接,但是该链接显示纯文本字体 Inserts an in-line link to another topic.
@param 说明一个方法的参数 @param parameter-name explanation
@return 说明返回值类型 @return explanation
@see 指定一个到另一个主题的链接 @see anchor
@serial 说明一个序列化属性 @serial description
@serialData 说明通过writeObject( ) 和 writeExternal( )方法写的数据 @serialData description
@serialField 说明一个ObjectStreamField组件 @serialField name type description
@since 标记当引入一个特定的变化时 @since release
@throws 和 @exception 标签一样. The @throws tag has the same meaning as the @exception tag.
{@value} 显示常量的值,该常量必须是static属性。 Displays the value of a constant, which must be a static field.
@version 指定类的版本 @version info
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,860评论 18 139
  • 冬季已经过去了,春季也到了,收起冬天厚厚的羽绒服,拿出春天的装扮。对于女生来说又到了要思考怎样穿衣怎样搭配,不同的...
    穿衣打扮吧阅读 328评论 0 0
  • 春光明媚,萋萋芳草地透着馥郁青草的香气,还有灿烂阳光的味道,一切都显得如此明朗和纯净,这便是最初的朋友圈...
    东方润木阅读 367评论 8 7
  • 一只站在树上的鸟儿,从来不会害怕树枝会断裂,因为它相信的不是树枝,而是它自己的翅膀。与其每天担心未来,不如努力做好现在。
    独行侠小优阅读 213评论 0 0