代 码 注 释
(Code comments)
在理解三层和机房三层+设计模式时,特别是三层运行时,师傅狠狠的指导了一
番,必须要一行一行运行原则,和怎么运行的,自己要能说出是怎么运行出来。 当初查
番,必须要一行一行运行原则,和怎么运行的,自己要能说出是怎么运行出来。 当初查
了一些网上资料,稂莠不齐,所以自己总结了一些代码注释的原则,还请多多指点:
代码的标准是英文,它的母语就是英文,现在不论是中国人、日本人还是俄国人在
开发软件,为了更好的理解和开发软件,都很有必要写一些相应的注释,为了更好的更
开发软件,为了更好的理解和开发软件,都很有必要写一些相应的注释,为了更好的更
改、维护等工作,代码注释不是必须的,但是它可以提高程序的可读性,建议养成写注释的习惯,基本的注释要求在20%~30%左右,有了代码的注释到时候自己也能更快更好的理解。
规范示例:
/头文件的头注释
/*************************************************
Copyright (C), 2013, DanielStark
File name: // 文件名
Author: Version: Date: 2013.3.02 DanielStark // 作者、版本及完成日期
Description: <pre name="code" class="csharp">/*************************************************
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)
Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)
Input: // 输入参数说明