Annotation to disable JavaDocs

前端 未结 4 1259
北恋
北恋 2021-01-18 14:32

Is there an annotation to declare that a certain method will not be included in the JavaDocs even though it is public?

Something like:

@nojavadocs
p         


        
4条回答
  •  栀梦
    栀梦 (楼主)
    2021-01-18 15:01

    Yes...but not in a good way (having methods that are public that aren't really "public" isn't a great design practice).

    You could follow the suggestion given in this thread and mark the method using @deprecated then when you run javadoc use option -nodeprecated.

    Edit: As others have noted, this is not a desirable course of action. This will solve your problem, but you really need to rethink why it is you want to hide the method -- given a compiled version of your code someone will still be able to see your function; hiding it in the documentation does not in fact hide the method. I really mean to stress here that the qualifiers private, public and protected have meaning which you should consider and utilize effectively. There is no such thing as a "hidden" public method.

提交回复
热议问题