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

Question

如果您@的 ASDoc 中有符号，则代码将编译，但 ASDoc 的生成器会发出无法理解的错误消息。

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

有什么方法可以@在您的 ASDoc 中包含符号而不会引发错误？

Answer 1

According to documentation by Adobe:

ASDoc passes all HTML tags and tag entities in a comment to the output. Therefore, if you want to use special characters in a comment, enter them using HTML code equivalents. For example, to use a less-than (<) or greater-than (>) symbols in a comment, use < and >. To use the at-sign (@) in a comment, use @. Otherwise, these characters are interpreted as literal HTML characters in the output.

Although not mentioned in the documentation,a fourth symbol that is not allowed is &, and must be replaced by &.

So, if one were to follow these instructions for the example ASDoc:

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

It may not be clear when looking at the comment in your editor, but it will be clear once the ASDoc has been compiled into HTML. Perhaps one could phrase the comment in such a way that the special characters aren't used:

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