代码注释

<h3>原则</h3> <ul> <li>代码注释尽可能的要多，方便后期交接人员阅读及维护代码。如方法功能注释、业务流程分步的每个步骤的注释等</li> <li>对于有特殊逻辑的地方，或不能快速理解的地方，相应代码行需加上注释</li> </ul> <h3>注释规约</h3> <ol> <li> <p>每个JS文件的开头写上创建者，创建日期，脚本类型，应用于，描述 <img src="https://www.showdoc.cc/server/api/common/visitfile/sign/2873417a8091c7739fa4851e7ec183bc?showdoc=.jpg" alt="" /></p> </li> <li>所有方法都必须加注释，用来说明用途、创建者、创建时间，Eclipse中添加注释方法：方法的上一行输入/**回车，样例 <img src="https://www.showdoc.cc/server/api/common/visitfile/sign/02e4c9579d7750c80bebc40b964492d5?showdoc=.jpg" alt="" /> 示例： <img src="https://www.showdoc.cc/server/api/common/visitfile/sign/fd804d2806a28a9a2c7bc424b4e58018?showdoc=.jpg" alt="" /></li> </ol>