【问题标题】:Automatic @since javadoc tag for releases用于发布的自动 @since javadoc 标记
【发布时间】:2011-03-25 22:32:27
【问题描述】:

当我想要发布版本时,是否有工具可以自动将@since 标签添加到所有元素?

假设我有一堆方法并且我的基础系统现在正在运行,所以我决定将其发布为 0.1.0 版

我现在想要的是一个工具,它可以搜索每个缺失的@since 标签并相应地添加它。

我正在使用 Eclipse,我找到了 JAutodoc,但据我所知,它只允许搜索丢失的标签,我必须手动添加它们。

编辑: 对某人来说可能会感兴趣的一种解决方法:从一开始就使用带有正确自标记的 Eclipse 模板,并在每次发布后更改模板。

【问题讨论】:

    标签: java javadoc documentation-generation


    【解决方案1】:

    我能否补充一下我在 27 年前学到的一课:不要试图让您的版本控制编号与您的产品发布编号保持一致。那就是疯狂所在。

    【讨论】:

    • 那么问题是:如果您的 API 是公开的并且其他人正在使用它,并且您有不同的版本并且不是每个人都有最新的,那么让人们知道他们是否可以使用特定的 API 是一件好事方法与否。还是你有更好的解决方案?我总是开放的;D
    【解决方案2】:

    这听起来像是您的构建工具应该为您提供的东西。如果你使用的是 maven,你应该看看 javadoc:fix。看起来它完全符合您的要求:

    http://maven.apache.org/plugins/maven-javadoc-plugin/fix-mojo.html

    【讨论】:

    • 前段时间我确实尝试过研究 maven。起初它看起来很有希望,现在仍然如此。但直到现在我还没有设法让它工作。不管怎样,从下个月开始,我希望有更多的时间,再看看。因此,到目前为止感谢!
    猜你喜欢
    • 1970-01-01
    • 2021-11-29
    • 2017-01-09
    • 1970-01-01
    • 2022-07-14
    • 2014-11-24
    • 2011-01-02
    • 2017-11-19
    • 2012-07-25
    相关资源
    最近更新 更多