如何引用*/&引用；在JavaDocs中

我需要在JavaDoc注释中包含

*/

。问题是，这也是关闭注释的相同顺序。引用/逃避这一点的正确方式是什么

例如：

/**
 * Returns true if the specified string contains "*/".
 */
public boolean containsSpecialSequence(String str)

跟进：似乎我可以使用

和#47用于斜杠。唯一的缺点是，当直接在文本编辑器中查看代码时，这不是所有的可读性

/**
 * Returns true if the specified string contains "*/".
 */

使用HTML转义

在你的例子中：

/**
 * Returns true if the specified string contains "*/".
 */
public boolean containsSpecialSequence(String str)

/作为“/”字符转义

Javadoc应该将转义序列插入到它生成的HTML中，并在浏览器中呈现为“*/”

如果您想非常小心，可以对这两个字符进行转义：
*/转换为
*/

编辑：

跟进：看来我可以使用/；
为了斜线。唯一的缺点是
这不是所有的可读性当
直接查看代码

那么？重点不在于代码是否可读，而在于代码文档是否可读。大多数Javadoc注释都嵌入了复杂的HTML来进行解释。见鬼，C#的等价物提供了一个完整的XML标记库。我在那里看到了一些非常复杂的结构，让我告诉你

编辑2:
如果太麻烦您，您可能会嵌入一个非javadoc内联注释来解释编码：

/**
 * Returns true if the specified string contains "*/".
 */
// returns true if the specified string contains "*/"
public boolean containsSpecialSequence(String str)

使用实体

*/ 

在您的文档中，它将显示为“*/”
我偶然发现的另一种方式，只是为了完整性：添加一些不会改变*和/之间输出的HTML标记

  /**
   * *<b/>/
   */

/**
* */
*/

与HTML转义解决方案相比，这似乎是一个丑陋的攻击，但它也会在HTML输出中产生正确的结果。
我建议您也在附近添加一行注释，如

// *&#47; is html for */

这是“正确”的解决方案，但为了可读性，我可能会选择：

/**
 * Returns true if the string contains an asterisk followed by slash.
 */

没有人提到。这是另一条路：

/**
*如果指定的字符串包含“*{@literal/}”，则返回true。
*/

不幸的是，您不能一次逃逸
*/
。这也解决了一些缺点：

唯一的缺点是，当直接在文本编辑器中查看代码时，这不是所有的可读性

/**
 * Returns true if the specified string contains "*&#47;".
 */

我会去参加B；。除了我之外，这会困扰其他人吗？现在它在javadoc中看起来不错，但是当你只看源代码时，它是不可读的…它不是完全不可读的。你是个程序员，对吗？您至少应该能够意识到这是一个HTML转义代码，即使您无法识别实际值。你可以随时查阅。正如我之前所说的，javadoc的要点是文档的可读性，而不是代码的可读性。也就是说，您可以在代码的其他地方嵌入一条非javadoc的注释来解释它。类似：//的搜索“*/”只需在IDE中打开javadoc视图。这些天他们往往非常棒……我只想补充一点，这是一个好问题的完美例子我喜欢bobince的建议，在“*/；”后面的括号中加上“星号加斜杠”。它在代码和Javadoc中都是可读的；您当前的建议可能会违反html文档类型。如果有人走这条路线，我会建议这样做：*/以确保标签已关闭。啊，我想知道这一点，但保持这样，因为这是最短的选项，在IDEA（Ctrl-Q）中效果很好。如果不是，那么*/或*/就够了吗？好吧，但当给出shell全局模式示例时，这个建议不是很有用，例如
foo/bar/**/baz.zip