Java 相当于<;请参阅langword="&引用/&燃气轮机;
我使用Java 相当于<;请参阅langword="&引用/&燃气轮机;,java,c#,javadoc,Java,C#,Javadoc,我使用编写C#API文档 将@link用于类,但不用于语言关键字,并且不鼓励使用@code: 仅在对特定类或方法的第一次引用中使用@link。使用@code进行后续引用 不要将@code用于null、true或false 但他并没有说我们不会对Java关键字使用其他任何东西 我在Java中使用什么来获得结果,还是干脆省略它?他并不是说根本不使用@code,而是说不要将它用于这三个关键字。@AndyTurner:没错,他没有说明这三个关键词应该用什么。第二句话的大背景是,它们太普遍了,你只会给读者
编写C#API文档
将@link
用于类,但不用于语言关键字,并且不鼓励使用@code
:
仅在对特定类或方法的第一次引用中使用@link。使用@code进行后续引用
不要将@code用于null、true或false
但他并没有说我们不会对Java关键字使用其他任何东西
我在Java中使用什么来获得
结果,还是干脆省略它?他并不是说根本不使用@code,而是说不要将它用于这三个关键字。@AndyTurner:没错,他没有说明这三个关键词应该用什么。第二句话的大背景是,它们太普遍了,你只会给读者和作者增加负担。所以,不要为那些人做,而是为所有其他人做。或者,不要遵循他的编码标准,这只是他的(可能是相当好的)意见。其含义是写null、true、false,而不是{@code null}
,{@code true}
,{@code false}
@AndyTurner:{@link true}
,{@see true}
或其他任何东西?对我来说没问题。我只是想知道为什么C#引入了一个额外的langword
参数,而Java中的建议是根本不格式化它。