Java 代码注释
<h6>Java 程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是使用/<em>...</em>/和//界定的注释。文档注释(被称为"doc comments")由/*<em>...</em>/界定。文档注释可以通过javadoc 工具转换成HTML 文件。</h6>
<p>1.文件注释</p>
<pre><code>所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。
如下：
/*
* 文件名
* 包含类名列表
* 版本信息，版本号
* 创建日期。
* 版权声明
*/</code></pre>
<p>2.类注释
每一个类都要包含如下格式的注释，以说明当前类的功能等。</p>
<pre><code>/**
* 类名
* @author 作者 &lt;br/&gt;
*实现的主要功能。
*创建日期
*修改者，修改日期，修改内容。
*/</code></pre>
<p>3.方法注释
每一个方法都要包含 如下格式的注释 包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。</p>
<pre><code> /**
*
* 方法的一句话概述
* &lt;p&gt;方法详述（简单方法可不必详述）&lt;/p&gt;
* @param s 说明参数含义
* @return 说明返回值含义
* @throws IOException 说明发生此异常的条件
* @throws NullPointerException 说明发生此异常的条件
*/</code></pre>
<p>4.类成员变量和常量注释
成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义</p>
<pre><code>/**
* XXXX含义
*/</code></pre>
<p>5.其他注释
方法内部的注释 如果需要多行 使用/<em>…… </em>/形式，如果为单行是用//……形式的注释。不要再方法内部使用 java doc 形式的注释“/<strong>……</strong>/”，简单的区分方法是，java doc形式的注释在 eclipse中为蓝色，普通注释为绿色。</p>
<p>6.XML注释
规约：如果当前layout 或资源需要被多处调用，或为公共使用的layout（若list_item），则需要在xml写明注释。要求注释清晰易懂。</p>
<p>7.模板导入方法
1.android-formatting.xml导入流程:
Window->Preferences->Java->Code Style->Formatter->Import
2.codetemplates.xml导入流程:
Window->Preferences->Java->Code Style->Code Templates->Import
3.android.importorder导入流程:
Window->Preferences->Java->Code Style->Organize imports->Import</p>
<pre><code>文件导入完成后，右键点击需要格式化的工程-&gt;Source-&gt;Format就可以格式化工程下面所有的java文件。
单个文件使用Ctrl+Shift+F即可。</code></pre>