Question

如果你的ASDoc中有@符号，代码将被编译，但ASDoc的生成器将大声喊出一条难以理解的错误消息。

/**
 * Removes the following characters which are forbidden:
 *    @/\"#$%&'()*:;<=>!?
 */
public function removeForbiddenChars(str:String):String

有没有办法在您的ASDoc中包含@符号而不会抛出错误？

Answer 1

根据documentation by Adobe：

ASDoc将注释中的所有HTML标记和标记实体传递给输出。因此，如果要在注释中使用特殊字符，请使用等效的HTML代码输入它们。例如，要在评论中使用小于（<）或大于（>）个符号，请使用<和>。 要在评论中使用旁注（@），请使用@。否则，这些字符将在输出中解释为文字HTML字符。

虽然文档中未提及，但不允许的第四个符号为&，必须由&替换。

所以，如果要遵循ASDoc示例的这些说明：

/**
 * Removes the following characters which are forbidden:
 *    &#64;/\"#$%&amp;'()*:;&lt;=&gt;!?
 */
public function removeForbiddenChars(str:String):String

在编辑器中查看注释时可能不太清楚，但是一旦将ASDoc编译为HTML，就会很清楚。也许人们可以用不使用特殊字符的方式来表达评论：

Removes /\"#$%'()*:;=!? as well as the 'at' symbol (&#64;), the ampersand symbol (&amp;), the 'less than' symbol (&lt;), and the 'greater than' symbol (&lt;)

在ASDoc注释中包含@而没有任何错误？

1 个答案: