首页 | 新闻 | 新品 | 文库 | 方案 | 视频 | 下载 | 商城 | 开发板 | 数据中心 | 座谈新版 | 培训 | 工具 | 博客 | 论坛 | 百科 | GEC | 活动 | 主题月 | 电子展
返回列表 回复 发帖

java注释模版(1)

java注释模版(1)

注释模版

下面给出注释的模版,直接复制粘贴到函数前面即可。

文件头注释

    /*
    * Created on 2005-7-2
    * /


类、接口注释

    /**Title: XXXX DRIVER 3.0
    *Description: XXXX DRIVER 3.0
    *Copyright: Copyright (c) 2003
    *Company:XXXX有限公司
    *
    * @author Java Development Group
    * @version 3.0
    */


构造函数注释

    /**
    * 默认构造函数
    */


    /**
    * 带参数构造函数,初始化模式名,名称和数据源类型
    *
    * @param schema
    * Ref 模式名
    * @param name
    * Ref 名称
    * @param type
    * byVal 数据源类型
    */


方法 函数注释

    /**
    * 设置是否有外码约束
    *
    * @param conn
    * Connection 与数据库的连接
    */



可能用到的标记

@param标记
@param后面空格后跟着参数的变量名字(不是类型),空格后跟着对该参数的描述。
在描述中第一个名字为该变量的数据类型,表示数据类型的名次前面可以有一个冠词如:a,an,the。如果是int类型的参数则不需要注明数据类型。例如:

* @param ch the char 用用来……
* @param _image the image 用来……
* @param _num 一个数字……

对于参数的描述如果只是一短语,最好不要首字母大写,结尾也不要句号。
对于参数的描述是一个句子,最好不要首字母大写,如果出现了句号这说明你的描述不止一句话。如果非要首字母大写的话,必须用句号来结束句子。(英文的句号)
公司内部添加ByRef和ByVal两个标记,例如:
* @param _image the image ByRef 用来……
说明该参数是引用传递(指针),ByVal可以省略,表示是值传递。


@return标记
返回为空(void)的构造函数或者函数,@return可以省略。
如果返回值就是输入参数,必须用与输入参数的@param相同的描述信息。
必要的时候注明特殊条件写的返回值。


@throws 标记
@throws以前使用的是@exception。
@throws的内容必须在函数的throws部分定义。


@author标记
类注释标记。
函数注释里面可以不出现@author。


@version
类注释标记。
函数注释里面可以不出现@version


@since
类注释标记。
标明该类可以运行的JDK版本
例如:
@since JDK1.2



@deprecated
由于某种原因而被宣布将要被废弃的方法。
/**
* @deprecated As of JDK 1.1, replaced by
* setBounds
* @see #setBounds(int,int,int,int)
*/


@link标记
语法:{@link package.class#member label}
Label为链接文字。
package.class#member将被自动转换成指向package.class的member文件的URL。



使用示例
我用方法注释,效果如图:




myeclipse自动注释设置

Window->Preference->Java -> Code Style -> Code Templates

files:新建文件时的注释

Types:类的注视

Field:变量的注释

Constructors:构造函数的注释

methods:一般方法的注释

可以在里edit一些固定的格式或变量

2.对JSP文件的注释

Window->Preference-myeclipse-editors-JSP-JSP TEMPLATES
返回列表