javadocs'{@ link #method}'中'#'的目的是什么？

Question

javadoc链接标记中散列'#'的目的是什么？

/** Call {@link #method} to do foo. */

Answer 1

它是类和方法之间的"分隔符".

例如,您可以在同一个类中包含对方法的引用:

{@link #methodA() whatever}

或者引用其他类中的方法,然后语法是class#method,即

{@link MyClass#methodA() whatever}

然后#是分隔符.

Answer 2

Javadoc使用#作为类和方法/构造函数签名或字段名称之间的分隔符,以避免模糊链接.

Javadoc @link和@see标记可以用于对类中的包,类和特定方法/构造函数或字段的引用.这可能不是很明显,但在包"ab"中有一个类"c",在同一个项目中有一个名为"c"的包"a"中的类"b"是合法的.到"package ab,class c"的Javadoc链接将被写为"abc",而到"package a,class b,field c"的链接将被写为"ab#c".如果名称不同,Javadoc工具也会接受.方法,构造函数或字段之前的分隔符.

如果链接以#开头,则它引用同一类中的方法/字段/构造函数.这类似于HTTP网址中的锚点使用,其中href ="doc.html#a1"指的是"doc.html"中的"a1"锚点,而href ="#a1"指的是"a1"锚点.同一份文件.