Javadoc:package.html或package-info.java

问题:

当尝试创建包级Javadoc注释时,首选方法是什么?你是做什么?
 package-info.java

  • 优点

     

    • Newer
  • 缺点

     

    • Abuse of a class – Classes are for code, not for only comments

 package.html的

  • 优点

     

    • HTML extension means its not code
    • Syntax highlighting in IDE’s/text editors
  • 缺点

     

    • None?

对我来说,我一直使用Package.html。但我想知道它是否是正确的选择。

回答:

 package-info.java:“这个文件是JDK 5.0中的新文件,而且优于package.html。” – javadoc – The Java API Documentation Generator
附录:大差异似乎是package annotations。在7.4 Package Declarations的理由中还有一点点
附录:注释功能也被提及herehere
附录:另见Declarative Programming in Java: Package-Level Annotations

 
 
Code问答: http://codewenda.com/topics/python/
Stackoverflow: Javadoc: package.html or package-info.java

*转载请注明本文链接以及stackoverflow的英文链接

发表评论

电子邮件地址不会被公开。 必填项已用*标注

− 3 = 3