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

来源:互联网 发布:java程序员做什么 编辑:程序博客网 时间:2024/06/05 11:50

大家在开发中写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代码:

 

Java代码  收藏代码
  1. /** 
  2.  * <h1>全局的类加载器</h1> 
  3.  * </br> 
  4.  * 继承于{@link ClassLoader},并重写了<tt>ClassLoader</tt>的{@link #findClass(String)} 
  5.  * 方法 
  6.  *  
  7.  * <p>该类主要是为了实现按业务模块隔离不同业务的类.防止jar冲突 
  8.  * </br>原有的<tt>URLClassLoader#findClass</tt>实现为  
  9.  * <pre> 
  10.  *  protected Class<?> findClass(final String name) 
  11.      throws ClassNotFoundException 
  12.     { 
  13.     try { 
  14.         return (Class) 
  15.         AccessController.doPrivileged(new PrivilegedExceptionAction() { 
  16.             public Object run() throws ClassNotFoundException { 
  17.             String path = name.replace('.', '/').concat(".class"); 
  18.             Resource res = ucp.getResource(path, false); 
  19.             if (res != null) { 
  20.                 try { 
  21.                 return defineClass(name, res); 
  22.                 } catch (IOException e) { 
  23.                 throw new ClassNotFoundException(name, e); 
  24.                 } 
  25.             } else { 
  26.                 throw new ClassNotFoundException(name); 
  27.             } 
  28.             } 
  29.         }, acc); 
  30.     } catch (java.security.PrivilegedActionException pae) { 
  31.         throw (ClassNotFoundException) pae.getException(); 
  32.     } 
  33.     } 
  34.  * </pre> 
  35.  *<p>如果想更多的了解该类请访问<a href="http://bernoulli.iteye.com/">bernoulli的博客</a> 
  36.  * @author 阿信 
  37.  * @version 1.2,2013.10.15 
  38.  * @see #findClass(String) 
  39.  * 
  40.  */  
  41. public class GlobalClassLoader extends ClassLoader {  
  42.   
  43.     @Override  
  44.     protected Class<?> findClass(String name) throws ClassNotFoundException {  
  45.           
  46.         return super.findClass(name);  
  47.     }  

 截图:

 



 

 

 

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

0 0
原创粉丝点击