javadoc - javadoc 注释中的代码示例

Question

我有多个程序员为 javadocs 贡献示例，一些示例包含格式化为

/*
 *
 */

当我将这些示例放入 javadoc 注释时，示例中的注释 close 将关闭 javadoc 注释。

/**
 *
 * /*
 *  *
 *  */  <-- right here
 *
 */

有没有正确的方法来处理这个而不告诉每个人他们不能以这种格式写评论？

Answer 1

Javadoc 注释使用 html，因此将/编码为实体:/

/**
 *
 * /*
 *  *
 *  *&#47;  <-- right here
 *
 */

告诉每个人不要在他们的代码示例中添加这种注释可能会更容易。