java文档注释笔记

    xiaoxiao2021-03-25  126

    文档注释/**…*/

         需要有相关文档兑程序说明时,但若文档与代码分离,则每次改变代码后都要改变文档,很麻烦,Java解决方案是:将代码同文档相关联,为达到此目的,最简单的就是将关联的文档都置于同一个程序文件中,然而,为标出程序中包含的文档,还必须使用一种特殊的注释语法,另外还需要一个工具,用于提取这些注释,并按有价值的形式将其展现出来,注释语法用的就是/**…*/,而用于提取注释的工具叫做javadoc,该工具不仅提取由特殊注释标记指示的信息,也将毗邻注释的类名或方法名提取出来,注释文档能用来生成HTML格式的代码报告,所以注释文档必须写在类,域,构造函数,方法,定义之前,注释文档由两部分组成:描述和块标记。

         @符号起头则为块标记注释,常见的javadoc块标记注释语法如下:

         @author      对类的说明,标明开发该类模块的作者

         @version      对类的说明,标记该类模块的版本

         @see         对类,属性,方法的说明,参考转向,也就是相关主题

         @param       对方法的说明,对方法中某参数的说明

         @return       对方法的说明,对方法返回值的说明

         @exception    对方法的说明,对方法可能抛出的异常进行说明

    Eclipse开发工具内部集成了javadoc,可生成HTML文档:

         法一:在程序所在项目列表中按右键选择:expert->Java->javadoc,进入javadoc generation对话框,选择保存路径,单击finish即可。

         法二:在上方菜单内选择:file->export->Java->javadoc,后续步

    如法一。

         法三:单击要生成的项目,然后在上方菜单栏内选择project->generate javadoc,后续步骤如法一

     

    l Java自动注释功能:

    在菜单栏内选择:window->perference->java->codestyle->code templates->comments;可开启自动注释功能,并对代码的通用模版进行编辑,以减轻注释工作量,注释类别包括files(新建文件时的注释),type(类的注释),filed(变量的注释),constructors(构造函数的注释),method(一般方法的注释)等。

    转载请注明原文地址: https://ju.6miu.com/read-1549.html

    最新回复(0)