为包添加上注释可以使我们清楚的知道这个包的作用,能够更加清晰的知道包中的核心问题所在,所以添加包注释很重要。
Eclipse 中在添加java文件时,是不允许添加Name 为package-info的java文件的。但我们可以通过向导创建一个普通的File文件,然后将其文件名命名为package-info.java.
==================================
http://esyscn.com/thread-62884-1-1.html
===============================
设置Eclipse代码模板
-
eclipse菜单: window->preferences,展开java->editor->templates,新建一个javadoc类型的模板:
- name设置为:package
- context选择:javadoc
- pattern输入:
xxx实现<a href="#" target="_blank">a name</a>. * <p> * <h1>detail1:</h1> * <img src="doc-files/test.png"/> * * @author <a href="mailto:skzr.org@gmail.com">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">