完善包注释[javadoc package-info.java]

包级注释

说明：

包级注释，有时候是非常有用的，可以清晰的表明包的设计和思路，可以贴上类图等等

参考：

Documentation Comments

快速创建：eclipse中怎样快速创建包注释

 

设置Eclipse代码模板

 

• eclipse菜单: window->preferences，展开java->editor->templates,新建一个javadoc类型的模板：

  1. name设置为：package
  2. context选择：javadoc
  3. pattern输入：
     

     xxx实现<a href="#" target="_blank">a name</a>.
      * <p>
      * <h1>detail1:</h1>
      * <img src="doc-files/test.png"/>
      * 
      * @author <a href="mailto:[e-mail]">skzr.org</a>
      * @since JDK1.6
      * @version 1.0.0

      

开发中使用

 

• 在你想要创建包注释的包下建立文件:package-info.java文件：
  

  /**
   *
   */
  package org.skzr.logging;

   
• 在第二行输入:"packa"按atl+/调出前面设置的模板，然后输入自己感兴趣的即可，最终效果如下：
  

  /**
   * slf4j本地化日志扩展实现<a href="http://code.google.com/p/slf4j-local" target="_blank">open sources</a>.
   * <p>
   * <h1>design:</h1>
   * <img src="doc-files/本地化日志实现设计.png"/>
   * <h1>class diagram:</h1>
   * <img src="doc-files/本地化日志类图.png"/>
   * 
   * @author <a href="mailto:[e-mail]">skzr.org</a>
   * @since JDK1.6
   * @version 1.0.0
   */
  package org.skzr.logging;

   

评论

1 楼 skzr.org 2011-03-27  

对于资源文件，如果想要引用，需要建立
doc-files目录，然后把东西放入这个目录下即可使用相对路径进行定位了