是否有一个注释来声明某个方法即使是公共的也不会包含在JavaDocs中?
就像是:
@nojavadocs
public void foo(){
//...
}
附:我理解这里关于 API 的要点,但这些方法只是“不受支持”。它们可以工作(并且必须公开才能从其他包访问),但我们不想费心记录它们并回答有关当它们的功能与支持的使用场景不相关时如何使用它们的问题。好的设计可能意味着将它们移动到另一个类,但它们在逻辑上引用类中的数据。
我能想到你想要这样做的唯一原因是在某种意义上“隐藏”该方法,即使只是在文档方面。如果您这样做,您就会将文档设计为“损坏”,因为当文档过时并且不再准确反映类的功能时,文档就会损坏。由于该方法仍然是公共 API 的一部分,因此您并没有真正隐藏它。
如果您希望某个方法在类外部或少数用户之外不使用,请将其设为私有或打包。如果这不方便并且必须是公开的,我只是非常清楚地记录其使用的限制,可能会使用命名约定(例如,python 就是这样做的,有下划线包围的实体名称,您可以看到但它们是意味着更多是类实现的一部分,而不是公共 api)
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)