个性化JavaDoc注释（为代码增添一份色彩）

---

作为一名程序员，还是一名刚入门的菜鸟，天天看着枯燥无味的代码，偶然间突发奇想，能不能让文档注释变得更漂亮呢，于是就花了一天多的时间自己个性化定义了一遍javadoc注释，下面是效果生成API的效果图：

软件包   类  使用  树  已过时  索引  帮助
上一个类   下一个类	框架    无框架     所有类
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

<hr

com.shangbo.domain 类 Employee

java.lang.Object

  com.shangbo.domain.Employee

---

public class Employee

extends java.lang.Object

#### 员工实体类 ####
●所属公司：ShangBo
●作者：Xg
●修改者：
●修改说明：
●创建时间：2018-5-30 下午10:30:54
●版本：V1.0

---

构造方法摘要

Employee()           类Employee的构造方法 ● 用于创造一个TestComment对象 示例：Employee varName = new Employee( );

Employee(java.lang.Integer id, java.lang.String name, java.lang.String post, java.lang.Integer salary, java.lang.String qq)           类Employee的构造方法 ● 用于创造一个TestComment对象 示例：Employee varName = new Employee( Integer id, String name, String post, Integer salary,String qq );

 

方法摘要
java.lang.Integer	getId()           ● getId(): Integer -- id ● 属性Employee.id的getter方法 ● 作用用于获取Employee.id的属性值
java.lang.String	getName()           ● getName(): String -- name ● 属性Employee.name的getter方法 ● 作用用于获取Employee.name的属性值
java.lang.String	getPost()           ● getPost(): String -- post ● 属性Employee.post的getter方法 ● 作用用于获取Employee.post的属性值
java.lang.String	getQq()           ● getQq(): String -- qq ● 属性Employee.qq的getter方法 ● 作用用于获取Employee.qq的属性值
java.lang.Integer	getSalary()           ● getSalary(): Integer -- salary ● 属性Employee.salary的getter方法 ● 作用用于获取Employee.salary的属性值
void	setId(java.lang.Integer id)           ● setId( ) ● 属性Employee.id的getter方法 ● 作用用于设置Employee.id的属性
void	setName(java.lang.String name)           ● setName( ) ● 属性Employee.name的getter方法 ● 作用用于设置Employee.name的属性
void	setPost(java.lang.String post)           ● setPost( ) ● 属性Employee.post的getter方法 ● 作用用于设置Employee.post的属性
void	setQq(java.lang.String qq)           ● setQq( ) ● 属性Employee.qq的getter方法 ● 作用用于设置Employee.qq的属性
void	setSalary(java.lang.Integer salary)           ● setSalary( ) ● 属性Employee.salary的getter方法 ● 作用用于设置Employee.salary的属性
java.lang.String	toString()           ◆ 重写：toString( ) ● 描述： 员工类的toString方法，重写该方法后可以直接使用System.out.println(员工对象)查看员工属性 ● 来自：@see java.lang.Object#toString() ● @return 员工属性的字符串形式

 

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

构造方法详细信息

Employee

public Employee()

类Employee的构造方法
● 用于创造一个TestComment对象
示例：Employee varName = newEmployee( );

---

Employee

public Employee(java.lang.Integer id,

                java.lang.String name,

                java.lang.String post,

                java.lang.Integer salary,

                java.lang.String qq)

类Employee的构造方法
● 用于创造一个TestComment对象
示例：Employee varName = newEmployee( Integer id, String name, String post, Integer salary,String qq );

参数：

id -

name -

post -

salary -

qq -

方法详细信息

getId

public java.lang.Integer getId()

● getId(): Integer -- id
● 属性Employee.id的getter方法
● 作用用于获取Employee.id的属性值

---

setId

public void setId(java.lang.Integer id)

● setId( )
● 属性Employee.id的getter方法
● 作用用于设置Employee.id的属性

---

getName

public java.lang.String getName()

● getName(): String -- name
● 属性Employee.name的getter方法
● 作用用于获取Employee.name的属性值

---

setName

public void setName(java.lang.String name)

● setName( )
● 属性Employee.name的getter方法
● 作用用于设置Employee.name的属性

---

getPost

public java.lang.String getPost()

● getPost(): String -- post
● 属性Employee.post的getter方法
● 作用用于获取Employee.post的属性值

---

setPost

public void setPost(java.lang.String post)

● setPost( )
● 属性Employee.post的getter方法
● 作用用于设置Employee.post的属性

---

getSalary

public java.lang.Integer getSalary()

● getSalary(): Integer -- salary
● 属性Employee.salary的getter方法
● 作用用于获取Employee.salary的属性值

---

setSalary

public void setSalary(java.lang.Integer salary)

● setSalary( )
● 属性Employee.salary的getter方法
● 作用用于设置Employee.salary的属性

---

getQq

public java.lang.String getQq()

● getQq(): String -- qq
● 属性Employee.qq的getter方法
● 作用用于获取Employee.qq的属性值

---

setQq

public void setQq(java.lang.String qq)

● setQq( )
● 属性Employee.qq的getter方法
● 作用用于设置Employee.qq的属性

---

toString

public java.lang.String toString()

◆ 重写：toString( )
● 描述： 员工类的toString方法，重写该方法后可以直接使用System.out.println(员工对象)查看员工属性
● 来自：@see java.lang.Object#toString()
● @return 员工属性的字符串形式

覆盖：

类 java.lang.Object 中的 toString

<hr

软件包   类  使用  树  已过时  索引  帮助
上一个类   下一个类	框架    无框架     所有类
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

在java源码中类的文档样式

成员变量的doc样式：

get方法和set方法的doc样式：

方法重写Doc样式：

一般方法的doc样式：

构造器Doc样式

基本大致就这些 ，这样看起来虽然乱但是当我们调用方法或者鼠标放到对应的方法或者属性上的时候，就能清楚的看到色彩玄冥的javaDoc注释了。

对咯，对于属性成员在myeclipse中，把光标移动到属性变量";"，然后使用快捷键"alt+shift+j"来自动添加我们自定义的文档注释，直接使用"/**+回车"是不行的

如要模板的朋友记得或者有不清楚的朋友都可以在留言区问我哟