码上敲享录 > java入门知识分享 > 单行注释、多行注释、文档注释最完美的解释、导出API

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

上一章章节目录下一章 2017-08-12已有3100人阅读 评论(0)

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

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


 

 

 





向大家推荐《Activiti工作流实战教程》:https://xiaozhuanlan.com/activiti
2

有建议,请留言!

  • *您的姓名:

  • *所在城市:

  • *您的联系电话:

    *您的QQ:

  • 咨询问题:

  • 提 交