java 文件头注释_myeclipse中java文件头注释格式设置

ゝ一纸荒年。 2022-11-03 11:15 120阅读 0赞

windows->preferences->java->Code Templates->comments->Type->edit

Eclipse注释规范模版总结

新建类文件

/\*\*

\* @ClassName:     $\{file\_name\}

\* @Description:   $\{todo\}(用一句话描述该文件做什么)

\* @author         $\{user\}

\* @version        V1.0

\* @Date           $\{date\}

$\{time\}

\*/

方法

/\*\*

\* @Title:

$\{enclosing\_method\}

\* @Description:  $\{todo\}(这里用一句话描述这个方法的作用)

\* @param:

$\{tags\}

\* @return:

$\{return\_type\}

\* @throws

\* @author        $\{user\}

\* @Date          $\{date\}

$\{time\}

\*/

输入设置模板：

/\*\*

\* $\{file\_name\} Create on $\{date\}

\* Copyright (c) $\{date\} by taotaosoft

\* @author

href="xiuzhong.li@gmail.com">Jerryli

\* @version 1.0

\*/

注意选择自动添加注释

养成一个规范的习惯是最好的。

选菜单

windows-->preference

Java-->Code Style-->Code Templates

code-->new Java files

选中点编辑

$\{filecomment\}

$\{package\_declaration\}

/\*\*

\* @author 作者姓名  E-mail: email地址

\* @version 创建时间：$\{date\} $\{time\}

\* 类说明

\*/

$\{typecomment\}

$\{type\_declaration\}

Eclipse注释规范模版总结

1、  具体操作

(1)在eclipse中，打开Window->Preference->Java->Code

Style->Code Template

(2)然后展开Comments节点就是所有需设置注释的元素，参照2注释规范对应设置即可

2、  注释规范

(1)文件(Files)注释标签

/\*\*

FileName:     $\{file\_name\}

@Description: $\{todo\}(用一句话描述该文件做什么)

\* All rights

Reserved, Designed By ZTE-ITS

Company       ZTE-ITS WuXi LTD.

@author:    名字

@version    V1.0

Createdate:         $\{date\}

$\{time\}

Modification  History:

Date         Author        Version        Discription

\* $\{date\}       wu.zh          1.0             1.0

\* Why

& What is modified:

\*/

(2)类型(Types)注释标签(类的注释)：

/\*\*

@ClassName:     $\{type\_name\}

@Description:$\{todo\}(这里用一句话描述这个类的作用)

@author:    Android\_Robot

@date:        $\{date\} $\{time\}

$\{tags\}

\*/

(3)字段(Fields)注释标签：

/\*\*

@Fields $\{field\} : $\{todo\}(用一句话描述这个变量表示什么)

\*/

(4)构造函数标签：

/\*\*

@Title:        $\{enclosing\_type\}

@Description:    $\{todo\}(这里用一句话描述这个方法的作用)

@param:    $\{tags\}

@throws

\*/

(5)方法(Methods)标签：

/\*\*

@Title: $\{enclosing\_method\}

@Description: $\{todo\}(这里用一句话描述这个方法的作用)

@param: $\{tags\}

@return: $\{return\_type\}

@throws

\*/

(6)覆盖方法(Overriding Methods)标签:

/\*\*

Title: $\{enclosing\_method\}

Description:

$\{tags\}

$\{see\_to\_overridden\}

\*/

(7)代表方法(Delegate Methods)标签：

/\*\*

$\{tags\}

$\{see\_to\_target\}

\*/

(8)getter方法标签：

/\*\*

@Title:        $\{enclosing\_method\}

@Description: please write your description

\* @return:     $\{field\_type\}

\*/

(9)setter方法标签：

/\*\*

@Title:  $\{enclosing\_method\}

@Description: please write your description

@return: $\{field\_type\}

\*/

ren

java 文件头注释_myeclipse中java文件头注释格式设置

发表评论取消回复

还没有评论，来说两句吧...

相关阅读

相关 Pycharm自定义文件头和函数注释

相关 vscode设置自动新建文件头注释及函数注释

相关 IDEA设置文件头注释

相关 Pycharm自动添加文件头注释和函数注释参数

相关去java文件注释_去除java文件中注释部分

相关 java 文件头注释_myeclipse中java文件头注释格式设置

相关设置Java文件注释格式

相关 c++文件\函数\头文件注释格式

相关 myeclipse 自动添加头时间，作者，文件注释

相关 IDEA/Pycharm文件头注释模板