如何在JavaDocs中引用“ * /”
我需要*/在我的JavaDoc评论中添加。问题在于，这也是关闭评论的相同顺序。引用/转义的正确方法是什么？
例：
/**
* Returns true if the specified string contains "*/".
*/
public boolean containsSpecialSequence(String str)
跟进 ：看来我可以使用/斜线。唯一的缺点是，当直接在文本编辑器中查看代码时，这并不是所有可读性。
/**
* Returns true if the specified string contains "*/".
*/
问题答案：
使用HTML转义。
因此，在您的示例中：
/**
* Returns true if the specified string contains "*/".
*/
public boolean containsSpecialSequence(String str)
/ 转义为“ /”字符。
Javadoc应该在其生成的HTML中插入完整的转义序列，并在浏览器中将其呈现为“ * /”。
如果你要非常小心，你无法逃脱这两个字符：*/转换为*/
编辑：
后续行动：看来我可以使用＆＃47; 为斜线。唯一的缺点是，当直接查看代码时，这并不是所有可读性。
所以？关键不是要使您的代码可读，而是要使您的代码 文档
可读。大多数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)
-
问题内容： 在过去的两个月中，我一直在使用Eclipse。我以前没有在其中使用javadocs。今天，我搜索了hibernate javadocs，并获得了hibernate-3.2.2.ga-javadoc.jar。但是我不知道如何在日食中添加它。有什么建议么！！ 问题答案： 在Eclipse中包含hibernet的简单步骤...... 访问 http://www.jboss.org/tools
-
问题内容： 我处理了大量直观的示例测试案例。是否有任何方便的方法将它们包含在Java源代码中并在Javadocs中进行链接，因此我的IDE可以在编码时自动显示它们（通过在IDE中调用Javadoc渲染器功能）？ 我尝试将图像放置在Java源代码旁边并使用，但是它没有使用（我使用了png）。 （注意-在这种情况下，它在我的测试源中） 问题答案： 由于您没有显示任何消息来源，所以我只能做个玻璃球猜测…
-
问题内容： 有一个普通的Java API的JavaDoc，有英文版和中文版，但似乎每个版本都需要单独的源代码。还有其他更方便的方法吗？ 问题答案： 不，基本上没有办法。 想到的唯一变通方法适用于生成的HTML页面：您可以将JavaDocs包围在使用CSS在语言之间切换的块元素中。考虑： 随后编辑JavaDocs的CSS，以便用户可以切换语言，例如：
-
可以使用javadoc工具生成Java文档。 它目前以html 4.0格式生成文档。 在java 9中，我们可以在命令行参数中使用-html5选项生成html 5格式的文档。 旧样式java文档 请考虑C:/ JAVA文件夹中的以下代码。 Tester.java /** * @author MahKumar * @version 0.1 */ public class Tester {
-
这看起来很基本，但我没有找到一种方法得到它。当我对一个类做F1时，我在IDE中获得的类文档没有方法摘要。没人觉得有用吗？基本上，我想了解构造函数和方法摘要http://docs.oracle.com/javase/6/docs/api/javax/xml/parsers/saxparser.html。
-
问题内容： 我在开发中使用Eclipse，Maven和Java。我使用Maven下载依赖项（如果可用，则下载jar文件和javadoc），并使用Maven的eclipse插件为Eclipse生成.project和.classpath文件。当下载的依赖项没有附加javadoc时，我在.classpath文件中手动添加了javadoc的链接，以便可以在Eclipse中看到依赖项的javadoc。然后，