Ste*_*ann 5 java eclipse javadoc
当我右键点击一个包 - > new - >包时,检查"create package-info.java",Eclipse 4.4.2将package-info.java的模板放入该目录.非常好.它看起来像这样:
/**
*
*/
/**
* @author John Doe
*
*/
package name.of.pkg;
Run Code Online (Sandbox Code Playgroud)
如您所见,有两个注释块.我的问题是:上部区块的目的是什么?
我无法看到它出现在生成的JavaDoc HTML中的任何位置.只有较低注释块中和作者上方的内容才会在输出中可见.在它们的行中只有一个星形的两条线是邀请但在输出中不可见.到目前为止,我从未在任何关于package-info.java的博客或文档中看到过两个评论块.
最重要的是许可协议.当您进入专业编程许可证时,让其他人知道他们在何处,如何以及是否可以使用此代码变得非常重要.
常见的sytax是:
/**
* LICENSE
*/
import java.util.*;
/**
* JavaDoc about the class
*
* @author Your Name <yourname@yourdomain.com>
*/
public class ClassName {}
Run Code Online (Sandbox Code Playgroud)
| 归档时间: |
|
| 查看次数: |
112 次 |
| 最近记录: |