CODEWITHSUNDEEP
javadocumentationcommentsjavadoc
Kong
Kong

Reputation: 9556

What does a # in a comment between class and method mean?

I've started to see class + method references in comments and documentation etc written as:

MyClass#myMethod

i.e. with a # between the class and method. Is this some sort of coding standard/convention?

Upvotes: 3

Views: 874

Answers (1)

Alfred Xiao
Alfred Xiao

Reputation: 1788

Official guideline is available at How to Write Doc Comments for the Javadoc Tool. Where：

@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package

To see the difference between @see and @link, please take a look at Another asked Question

Upvotes: 5

Related Questions