第四十四条:为所有导出的API元素编写文档注释

简而言之,要为API编写文档,文档注释是最好,最有效的途径。对于所有可导出的API元素来说,使用文档注释应该被看作是强制性的。要

采用一致的风格来遵循标准的约定。记住,在文档注释内部出现任何的HTML标签都是允许的,但是HTML元字符必须要经过转义。

posted @ 2015-05-11 09:27  wangliyue  阅读(110)  评论(0编辑  收藏  举报