ActionScript中的代码诠释常用的ASDoc规范

2012-06-20

ActionScript中的代码注释常用的ASDoc规范优美的注释是优美代码的重要组成部分。好的注释不仅可以让别人快

ActionScript中的代码注释常用的ASDoc规范

优美的注释是优美代码的重要组成部分。好的注释不仅可以让别人快速理解代码，部分语言还可以用注释生成对应的html文档，在不看源码的情况下快速了解框架，或后期的具体查询。熟悉Java 的程序猿都知道Javadoc，不知用ActionScript的程序猿都知道asdoc不？asdoc和Javadoc类似，是adobe官方提供的ActionScript的API文档生成工具。要想能成功生成API文档，代码的注释需要满足一定的规范。

以下是我写的用于演示且带有详细注释的测试代码。其中很多内容可能和类无关，只是想尽可能多地列出一些常用的注释规范：

</p></blockquote><p><br></p><p>            对应的API文档如下：</p><blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015206.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="509" width="910"><br></p></blockquote>声明为public的变量必须写用（/**  */）写清楚注释。<blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015207.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="102" width="412"><br></p></blockquote><blockquote><p>对应的API文档为：<img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015208.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="104" width="943"><br></p></blockquote>类的构造方法要写清楚构造什么对象，参数和异常。<blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015209.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="237" width="786"></p></blockquote><p><br></p><p>             对应的API文档为：</p><blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015210.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="241" width="940"><br></p></blockquote>类的get或set方法可只对get方法进行注释，且不用@return。<blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015211.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="152" width="562"></p></blockquote><p>             对应的API文档为：</p><blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015212.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="179" width="944"><br></p></blockquote>类的其他public方法要注释好该方法的功能、参数、参考方法和返回值等。<blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015213.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="105" width="634"></p></blockquote><p>            对应的API文档为：</p><blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015214.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="144" width="1024"><br></p></blockquote>类方法中写例子时用@example标签，且代码直接粘贴在<listing version="3.0">和</listing>之间。<blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015215.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="226" width="633"></p></blockquote><p>             对应的API文档为：</p><blockquote><p><img src="//img.reader8.net/uploadfile/jiaocheng/20140140/2729/2014012718293015216.png" alt="ActionScript中的代码诠释常用的ASDoc规范" height="244" width="941"><br></p></blockquote><p><br></p><p><br></p><br><p></p><p><br></p> </p><div class="aged2"><script type="text/javascript">a("article_content_down");</script></div>
 </div>
<div id="pagebox" >
<a href="/jiaocheng/biancheng/" target="_blank">查看更多</a>
<A href="/jiaocheng/20130910/1826181.html" title="HDU   3339  In Action(01双肩包+Dijkstra算法)">下一篇</A></div>
<div id="MainLeftll">
<div id="MainLeftllToolbar">本文网址：<a href="https://www.reader8.net/jiaocheng/20120620/1826184.html">https://www.reader8.net/jiaocheng/20120620/1826184.html</a></div>
<div class="related"><span class="relatedIco1">读书人精选</span>
<ul class="relatedList">
</ul>
</div>
<div class="aged3"><script type="text/javascript">a("article_content_down2");</script></div>
<div class="aged3a"><script type="text/javascript">a("article_content_down3");</script></div>
</div>
</div>
<!-- 文章正文左边结束 -->
<!-- 文章正文右边开始 -->
<div class="leftbox_r">
<div class="aged4"><script type="text/javascript">a("article_right_up");</script></div> 
<div class="Rtitle">
<span class="Rtitle_text">热点排行</span></div>
<div class="RContl">
<ul>
<li><a href="/jiaocheng/20140123/1912529.html" target="_blank">maven 项目平添Maven Dependencies Libr</a></li>
<li><a href="/jiaocheng/20140122/1943016.html" target="_blank">java类静态域、块，非静态域、块，结构函</a></li>
<li><a href="/jiaocheng/20140125/1973610.html" target="_blank">Golang的slice圈套</a></li>
<li><a href="/jiaocheng/20140715/2477185.html" target="_blank">Spring2 兑现AOP编程的两种实现方法</a></li>
<li><a href="/jiaocheng/20140705/2451858.html" target="_blank">树的底层实现（下）</a></li>
<li><a href="/jiaocheng/20140424/2313132.html" target="_blank">多线程程序的评量基准</a></li>
<li><a href="/jiaocheng/20140721/2494264.html" target="_blank">struts2札记之第七讲</a></li>
<li><a href="/jiaocheng/20140709/2460644.html" target="_blank">jquery 用ID取某个元素上的某个ID元素</a></li>
<li><a href="/jiaocheng/20121222/1909994.html" target="_blank">scoket创设多线程服务器</a></li>
<li><a href="/jiaocheng/20121107/1927300.html" target="_blank">基于glut的OpenGL框架（1）</a></li>
</ul>
</div>
<div class="aged7"><script type="text/javascript">a("article_right_up2");</script></div>
<!-- 文章正文右边结束 -->
</div>
<!--主体结束-->
<script type="text/javascript">a("article_down_up");</script>
<script type="text/javascript">a("foot");</script>
<script type="text/javascript">a("article_down_up2");</script>
<!--主体结束-->
<div style="display:none"> 
<!--百度统计代码--> 
<script>
var _hmt = _hmt || [];
(function() {
  var hm = document.createElement("script");
  hm.src = "https://hm.baidu.com/hm.js?d6151f323a57d16696165e47eee86d53";
  var s = document.getElementsByTagName("script")[0]; 
  s.parentNode.insertBefore(hm, s);
})();
</script>
</div> 
<script type="text/javascript">a("allbt");</script>
</body>
</html>