使用HTML转义。
那么在你的例子中:
/**
* Returns true if the specified string contains "*/".
*/
public boolean containsSpecialSequence(String str)
"/
"被转义为"/"字符。"
Javadoc应该将转义序列原封不动地插入其生成的HTML中,然后在浏览器中呈现为“*/”。
如果你想要非常小心,你可以转义两个字符:*/
转换成 */
。
编辑:
Follow up: It appears I can use /
for the slash. The only downside is
that this isn t all that readable when
view the code directly.
所以呢?重点不在于你的代码可读性,重点在于你的代码文档可读性。大部分Javadoc注释中都包含了复杂的HTML用于解释。C#等价物提供了完整的XML标签库。我曾经看过一些非常复杂的结构,让我告诉你。
Edit 2:
If it bothers you too much, you might embed a non-javadoc inline comment that explains the encoding:
/**
* Returns true if the specified string contains "*/".
*/
// returns true if the specified string contains "*/"
public boolean containsSpecialSequence(String str)