编码规范
1 目的
为了保证公司软件开发、设计过程中代码的一致性及可读性,便于交流和维护,特制定此规范。
2 范围
本规范适用于开发组全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。
3 注释规范
3.1 概述
a) 注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细
的描述。
b) 每行注释的最大长度为100个字符。 c) 将注释与注释分隔符用一个空格分开。 d) 不允许给注释加外框。 e) 编码的同时书写注释。 f) 重要变量必须有注释。
g) 变量注释和变量在同一行,所有注释必须对齐,与变量分开至少两个
“Tab”键。
如:objDataTable = (DataTable)Session["Purview"]; // 判断权限
string m_strSql; // sql语句 h) 典型算法必须有注释。
i) 在循环和逻辑分支地方的上行必须就近书写注释。 j) 程序段或语句的注释在程序段或语句的上一行 k) 在代码交付之前,必须删掉临时的或无关的注释。
3.2 自建代码文件注释
对于自己创建的代码文件(如函数、脚本),在文件开头,一般编写如下注释:
/****************************************************** FileName:
Copyright (c) 2010-0506 武汉博兴电气技术有限责任公司软件开发部
C#编码规范 暂无评价0人阅读0次下载举报文档编码规范江西微软技术中心 2011-08 Agenda 一、概述 二、实例讲解 三、注意点 四、Q&A ...
C#编码规范 暂无评价0人阅读0次下载举报文档C#编码规范 C#编码规范 第一版 江苏微软技术中心 规范的制定原则: 规范的制定原则: 1 参照...
C#编码规范_电脑基础知识_IT/计算机_专业资料。东方软件科技有限公司编码规范(C#...永远别设想你的代码是在"C:"盘运行。 你不会知道, 一些用户在网络或"Z:"...
SQL编码规范 签入式SQL-举例 巧用快捷键 VS2010中的快捷键名称 注释所选内容 查找 切换打开的文件 操作 Ctrl+K,Crtr+C Ctrl+F Ctrl+Tab 描述 先按Ctrl+K,...
加上了这个选项的时候编译很慢; C)详设的时候打开开关,检查详设是否符合编程规范; D)所有的选项都应当打开。以下内容需要单独设置: 编码 CA2209 CA1814 CA1822...
C#编码规范_工学_高等教育_教育专区。C#编码规范技术笔记,如何系列 C#编码风格指南...你也可以使用旧的 C 语言的样式 风格来做单行注释,尽管这并被推荐。一旦你...
加上了这个选项的时候编译很慢; C)详设的时候打开开关,检查详设是否符合编程规范; D)所有的选项都应当打开。以下内容需要单独设置: 编码 名称 程序集应声明最小...
加上了这个选项的时候编译很慢; C)详设的时候打开开关,检查详设是否符合编程规范; D)所有的选项都应当打开。以下内容需要单独设置: 编码 CA2209 名称 程序集...
C#编码规范_电脑基础知识_IT/计算机_专业资料。C#编码规范目录 1. 2. 3. 4...这些理由包括: A)类为静态类; B)类的受保护成员保存了高度机密信息; C)类...
热门文档