实用简约的JAVA注释标签-高手必备

 

大家在开发中写JAVA注释谁都会,不会一般写得少或者随便写，其实这是习惯问题,与开发进度无关。养成良好的习惯会觉得写出来的代码很专业，很有成就感 。最近看开源框架里面的JAVA注释。觉得很有意思。做下记录:

通常注释包括以下几个部分:

功能描述,参数,作者,版本,看另一方法

参数：@param

作者: @author Administrator

版本:@version

看另一方法：@see   #resolveClass(Class)  会生成一个跳转到同类的resolveClass方法

 

描述一般用HTML标签

java注释支持许多HTML标签。下面介绍常用的标签:

 

</br> 换行,一行简要功能后详细的描述可以换行再写

 

<tt></tt> 在注释用到其他的类名可以用该标签格式化,会使类名显示与众不同哦。效果如下:

 

 

<p> 段落,该标签可自动换行并空出一行

 

 

 

 

 

{@link String} 链接到String类 

前面介绍了tt标签可以配合起来使用 {@link ClassA <tt>ClassA</tt>} 前面一个ClassA是类名,第二个ClassA是显示文字

 

 

<pre></pre>有时候会在注释中写一段示例代码。一般写法会不换行的。

不加pre的话全部换行会无效，效果如下：

 

加上换行就好多了，效果如下：

 

<h1></h1>

 

<h2></h2>

 

...

<h4></h4>

 

最后来一张综合性的:

java代码:

 

/**
 * <h1>全局的类加载器</h1>
 * </br>
 * 继承于{@link ClassLoader},并重写了<tt>ClassLoader</tt>的{@link #findClass(String)}
 * 方法
 * 
 * <p>该类主要是为了实现按业务模块隔离不同业务的类.防止jar冲突
 * </br>原有的<tt>URLClassLoader#findClass</tt>实现为 
 * <pre>
 *  protected Class<?> findClass(final String name)
	 throws ClassNotFoundException
    {
	try {
	    return (Class)
		AccessController.doPrivileged(new PrivilegedExceptionAction() {
		    public Object run() throws ClassNotFoundException {
			String path = name.replace('.', '/').concat(".class");
			Resource res = ucp.getResource(path, false);
			if (res != null) {
			    try {
				return defineClass(name, res);
			    } catch (IOException e) {
				throw new ClassNotFoundException(name, e);
			    }
			} else {
			    throw new ClassNotFoundException(name);
			}
		    }
		}, acc);
	} catch (java.security.PrivilegedActionException pae) {
	    throw (ClassNotFoundException) pae.getException();
	}
    }
 * </pre>
 *<p>如果想更多的了解该类请访问<a href="http://bernoulli.iteye.com/">bernoulli的博客</a>
 * @author 阿信
 * @version 1.2,2013.10.15
 * @see #findClass(String)
 *
 */
public class GlobalClassLoader extends ClassLoader {

	@Override
	protected Class<?> findClass(String name) throws ClassNotFoundException {
		
		return super.findClass(name);
	}

 截图:

 

 

 

 

 上面的标签都是常用的标签。开始强制自己使用,过两天就习惯了。非常方便实用,注释也非常优美看上去非常专业，心里真是美滋滋。