Eclipse Java注释模板设置详解以及版权声明
<p>网上的Eclipse注释模板,在这里稍稍整理一些比较常用的。</p>
<p>编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:</p>
<p>1.文件(Files)注释标签:</p>
<pre><code>/**
* All rights Reserved, Designed By www.tydic.com
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author: ${user}
* @date: ${date} ${time}
* @version V1.0
* @Copyright: ${year} www.tydic.com Inc. All rights reserved.
* 注意:本内容仅限于xxx信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目
*/</code></pre>
<p>2.类型(Types)注释标签(类的注释):</p>
<pre><code>/**
* @ClassName: ${type_name}
* @Description:${todo}(这里用一句话描述这个类的作用)
* @author: ${user}
* @date: ${date} ${time}
*
* ${tags}
* @Copyright: ${year} www.tydic.com Inc. All rights reserved.
* 注意:本内容仅限于xxx信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目
*/ </code></pre>
<p>3.字段(Fields)注释标签:</p>
<pre><code>/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/ </code></pre>
<p>4.构造函数标签:</p>
<pre><code>/**
* @Title: ${enclosing_type}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param: ${tags}
* @throws
*/</code></pre>
<p>5.方法(Methods)标签:</p>
<pre><code>/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param: ${tags}
* @return: ${return_type}
* @throws
*/</code></pre>
<p>6.覆盖方法(Overriding Methods)标签:</p>
<pre><code>/**
* &lt;p&gt;Title: ${enclosing_method}&lt;/p&gt;
* &lt;p&gt;Description: &lt;/p&gt;
* ${tags}
* ${see_to_overridden}
*/ </code></pre>
<p>7.代表方法(Delegate Methods)标签:</p>
<pre><code>/**
* ${tags}
* ${see_to_target}
*/</code></pre>
<p>8.getter方法标签:</p>
<pre><code>/**
* @Title: ${enclosing_method} &lt;BR&gt;
* @Description: please write your description &lt;BR&gt;
* @return: ${field_type} &lt;BR&gt;
*/ </code></pre>
<p>9.setter方法标签:</p>
<pre><code>/**
* @Title: ${enclosing_method} &lt;BR&gt;
* @Description: please write your description &lt;BR&gt;
* @return: ${field_type} &lt;BR&gt;
*/ </code></pre>