我有多个程序员为 javadocs 提供示例，一些示例包含格式为的注释
/*
*
*/
当我将这些示例放入 javadoc 注释时，示例中的注释关闭了 javadoc 注释。
/**
*
* /*
* *
* */ <-- right here
*
*/
有没有适当的方法来处理这个问题，而不告诉每个人他们不能用这种格式写评论？
问问题
3045 次
5 回答
10
Javadoc 注释使用 html，因此将 / 编码为一个实体：/
/**
*
* /*
* *
* */ <-- right here
*
*/
告诉每个人不要在他们的代码示例中添加这种注释可能会更容易。
于 2009-07-10T13:32:47.303 回答
3
在我看来，如果代码不是不言自明的，或者至少不够简单，无法通过简短的描述来理解，那么应该重构代码。它需要更短，或者变量需要更易于理解，或者逻辑需要重新思考。
无论如何，我不相信有办法解决它，如果您想包含一个示例，那么在该示例中不要有任何评论。如果您确实必须有注释，请使用 // 符号。
于 2009-07-10T13:27:10.040 回答
0
为什么要将已注释的源代码放入注释中？
如果有必要的话，这听起来像是您的设计有问题。
于 2009-07-10T13:27:25.390 回答
0
Javadoc 注释中允许使用 HTML。将代码包含在您的注释中<code>或<pre>元素中。例如：
/**
* Outputs "Hello World" to the console.
*
* <code>System.out.println("Hello World");</code>
*/
于 2009-07-10T13:31:16.697 回答
0
"/* */" 注释不能嵌套。"//" 注释可以，但它们只在它们开始的行的末尾有效。
一般来说，在 JavaDocs 中包含实际代码并不是一件好事——一方面，它们应该更抽象（事物的“为什么”而不是“如何”）。
于 2009-07-10T13:39:19.090 回答