包括@在ASDoc注释没有任何错误?(Include @ in ASDoc comments wit

2019-10-20 03:00发布

如果你有@符号在你的ASDoc,代码可以编译,但对于ASDoc的发电机会嚷嚷着难以理解的错误消息。

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

有没有什么办法包括@在你的ASDoc符号,而被抛出的错误?

Answer 1:

根据由Adobe文档 :

ASDoc的通过了所有的HTML标签和标签实体中输出的注释。 因此,如果你想在评论使用特殊字符,使用HTML代码等效输入。 例如,使用一个小于( < )或大于( >在注释中,使用)符号&lt;&gt;要使用at符号( @在注释中,使用) &#64; 否则,这些字符解释为文字输出HTML字符。

虽然文献中未提到的,这是不允许的第四符号是& ,并且必须被替换&amp;

所以,如果一个人要遵循的例子的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;)


文章来源: Include @ in ASDoc comments without any errors?