javadoc注释中的代码示例

Question

我有多个程序员为javadoc提供示例,一些示例包含格式化的注释

/*
 *
 */

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

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

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

Answer 1

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

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

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