【问题标题】:package-info.java in Spring MVCSpring MVC 中的 package-info.java
【发布时间】:2013-02-28 08:48:35
【问题描述】:

我刚刚下载了 Pet Clinic 示例(我想将其重写为 Spring Portlet MVC)并且在每个包中都有 package-info.java 类。除了包声明,文件是空的,那么这有什么用?我可以在 Spring Portlet MVC 中安全地省略它吗?

【问题讨论】:

    标签: java spring spring-mvc spring-portlet-mvc


    【解决方案1】:

    您可以安全地删除这些内容,但根据我的经验,您通常只需在此文件的注释中说明软件包的用途即可。

    您可以在 Oracle 网站here找到更多信息

    【讨论】:

    • 哇,我从未见过这样的“最佳实践”。感谢您的澄清
    • 是的,我必须承认,我是最近才真正接触到它们,当时一位同事开始编写它们,但它们非常有用。特别是如果它说一个包含大量业务逻辑的包,而您只需要一个文件来描述“这个包实际上做了什么?”。我不确定它是否会生成为 javadoc,尽管就像说接口注释一样。
    • 我明白这一点,但我不确定它是否真的有必要,包应该相当小,具有明确的职责和正确的名称。但这并不总是可能的,所以这个“帮助文件”有时很有用,很高兴知道:)
    • 我同意它不应该是必需的,因为代码应该是自我记录的,但有时软件的域可能比软件本身更复杂(尤其是在某些 SAP/ERP 系统中)所以我发现在这些情况下它很有用,只是为了了解包的用途。不过,每个人都有自己的特色,不管对你的团队有用:)
    • @david99world package-info.java 文件正在为包生成 Javadoc 页面,例如:link。此外,在概览中显示每个包的包信息的第一句:link
    猜你喜欢
    • 2011-04-08
    • 2021-05-10
    • 1970-01-01
    • 2023-03-25
    • 2011-10-09
    • 2010-11-11
    • 2014-04-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多