@since和@version在私有方法文档中的用法

时间:2016-09-09 06:57:02

标签: java javadoc code-documentation

我正在阅读有关什么时候需要在Java类的文档中提供@since@version,但是什么时候提供它们是合适的?它们是否适用于所有可见性类型,或仅是public和/或protected

我理解version特定于函数或成员的迭代,而since与它引入的版本有关,但是将它添加到每个版本是正确的做法会员和职能?

示例:

/**
 * @version 1.2
 * @since 1.0
 */
public void myPublicMethod() {
    // this would be acceptable
}

/**
 * @version 2.1
 * @since 1.5
 */
private void myPrivateMethod() {
    // but would this?
}

0 个答案:

没有答案