admin 管理员组文章数量: 887021
2024年1月5日发(作者：select distinct from where)
东软集团有限公司 C#编程规范2.0
javasript编程规范
东软集团有限公司 C#编程规范2.0
目录
第一章 概述 ...........................................................................................................................................................4
规范制定原则 ......................................................................................................................................................4
术语定义 ...............................................................................................................................................................4
Pascal
大小写.................................................................................................................................................4
Camel
大小写 .................................................................................................................................................4
文件命名组织 ......................................................................................................................................................4
1.3.1文件命名.................................................................................................................................................4
1.3.2文件注释.................................................................................................................................................4
第二章 代码外观................................................................................................................................................5
2.1
2.2
2.3
2.4
2.5
2.6
2.7
列宽 ..........................................................................................................................................................5
换行 ..........................................................................................................................................................5
缩进 ..........................................................................................................................................................5
空行 ..........................................................................................................................................................5
空格 ..........................................................................................................................................................5
括号
-
() ...................................................................................................................................................6
花括号
-
{} .............................................................................................................................................6
第三章 程序注释 ....................................................................................................................................................7
3.1
3.2
3.3
3.4
3.5
注释概述 .................................................................................................................................................7
文档型注释.............................................................................................................................................7
类C注释 .................................................................................................................................................8
单行注释 .................................................................................................................................................8
注释标签 .................................................................................................................................................8
第四章 申明 .........................................................................................................................................................11
4.1
4.2
4.3
每行声明数...........................................................................................................................................11
初始化....................................................................................................................................................11
位置 ........................................................................................................................................................11
第五章 命名规范 ................................................................................................................................................12
5.1
5.2
5.3
5.4
5.5
5.6
5.7
5.8
5.9
命名概述 ...............................................................................................................................................12
缩写 ........................................................................................................................................................12
类.............................................................................................................................................................13
属性 ........................................................................................................................................................14
参数 ........................................................................................................................................................14
方法 ........................................................................................................................................................14
事件 ........................................................................................................................................................14
变量 ........................................................................................................................................................15
常量 ........................................................................................................................................................15
第六章 语句 .........................................................................................................................................................15
6.1
每行一个语句 ......................................................................................................................................15
东软集团有限公司 C#编程规范2.0
6.2
6.3
6.4
6.5
6.7.
6.9.
6.10.
复合语句 ...............................................................................................................................................15
RETURN
语句............................................................................................................................................16
IF、 IF-ELSE、IF ELSE-IF
语句 .........................................................................................................16
WHILE
语句 ...........................................................................................................................................17
SWITCH
- CASE
语句 ............................................................................................................................17
TRY
- CATCH
语句..............................................................................................................................18
WITH
块语句 ......................................................................................................................................18
6.4 FOR、FOREACH
语句 ..................................................................................................................................16
东软集团有限公司 C#编程规范2.0
第一章 概述
规范制定原则
1 方便代码的交流和维护。
2 不影响编码的效率，不与大众习惯冲突。
3 使代码更美观、阅读更方便。
4 使代码的逻辑更清晰、更易于理解。
术语定义
Pascal
大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如：
BackColor
Camel
大小写
标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：
backColor
文件命名组织
1.3.1文件命名
1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。
2 使用统一而又通用的文件扩展名： js文件.js
1.3.2文件注释
1 在每个文件头必须包含以下注释说明
/*----------------------------------------------------------------
// 文件名：
// 文件功能描述：
//
//
// 创建标识：
//
// 修改标识：
// 修改描述：
//
// 修改标识：
// 修改描述：
//----------------------------------------------------------------*/
文件功能描述只需简述，具体详情在类的注释中描述。
东软集团有限公司 C#编程规范2.0
创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如：
黄小文20070408
一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。
第二章 代码外观
2.1 列宽
代码列宽控制在110字符左右。
2.2 换行
当表达式超出或即将超出规定的列宽，遵循以下规则进行换行
1、在逗号后换行。
2、在操作符前换行。
3、规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
2.3 缩进
缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。
2.4 空行
空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。
在以下情况下使用两个空行
1、类与类的定义之间。
在以下情况下使用一个空行
1、方法与方法、属性与属性之间。
2、方法中不同的逻辑块之间。
3、注释与它注释的语句间不空行，但与其他的语句间空一行。
2.5 空格
在以下情况中要使用到空格
1、 关键字和左括符 “(” 应该用空格隔开。如
if (true)
注意在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关
东软集团有限公司 C#编程规范2.0
键字。
2、 多个参数用逗号隔开，每个逗号后都应加一个空格。
3、 语句中的表达式之间用空格隔开。如
for (expr1; expr2; expr3)
2.6 括号 - ()
1、 左括号“(” 不要紧靠关键字，中间用一个空格隔开。
2、 左括号“(” 与方法名之间不要添加任何空格。
3、 没有必要的话不要在返回语句中使用()。如
if (condition)
(1)
return 1
2.7 花括号 - {}
1、 左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如
if (condition)
{
}
function Add(x,y)
{
}
2、 左花括号 “{” 要与相应的右花括号 “}”对齐。
3、 通常情况下左花括号 “{”单独成行，不与任何语句并列一行。
4、 if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。如
if (somevalue == 1)
{
somevalue = 2;
}
5、 右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如
while (1)
{
东软集团有限公司 C#编程规范2.0
if (valid)
{
} // if valid
else
{
} // not valid
} // end forever
第三章 程序注释
3.1 注释概述
1、修改代码时，总是使代码周围的注释保持最新。
2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.
3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。
4 、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。
5 、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。
6 、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。
7 、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。
8 、在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。
9 、在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。
10 、避免多余的或不适当的注释，如幽默的不主要的备注。
11、 使用注释来解释代码的意图。它们不应作为代码的联机翻译。
12 、为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。
13 、对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。
14 、在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。
15 、用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。
16 、在所有的代码修改处加上修改标识的注释。
3.2 文档型注释
该类注释采用.Net已定义好的Xml标签来标记，在声明类、方法、属性都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。如
///
/// 指定的标头名称。
/// 指定的标头值。
der = function(p_name, p_value)
{
if (_headers == null)
{
东软集团有限公司 C#编程规范2.0
_headers = new nary();
}
_(p_name, p_value);
}
3.3 类c注释
该类注释用于
1 不再使用的代码。
2 临时测试屏蔽某些代码。
用法
/*
[修改标识]
[修改原因]
. . . (the source code )
*/
3.4 单行注释
该类注释用于
1 方法内的代码注释。如变量的声明、代码或代码段的解释。注释示例：
// 注释语句
var number;
2 方法内变量的声明或花括号后的注释, 注释示例：
if ( 1 == 1)
// always true
{
statement;
} // always true
3.5 注释标签
标签
用法
c>text
作用
为您提供了一种将说明中的文本标记为代码的方法。使用 将多行指示为代码
用于诸如
text 希望将其指示为代码的文本。
content段落文本。
东软集团有限公司 C#编程规范2.0
description 应当用于方法声明的注释中，以描述方法name 为方法参数名。将此名称用单引号括起来 (' ')。
的一个参数。
name
要引用的参数名。将此名称用双引号括起来
(" ")。
cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将
member 传递给输出 XML 中的元素名。必须将
member 括在双引号 (" ") 中。
cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将
member 传递给输出 XML 中的元素名。必须将
member 括在双引号 (" ") 中
使您得以指定希望在“请参阅”一节中出现的文本。使用
标记的使用。
description
代码示例的说明。
content
content 为希望将其标记为代码的文本。
此处description 为对象的摘要。
cref="member">description
cref = "member" 对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后，将
member 转换为输出 XML 中的规范化元素名。必须将
member 括在双引号 ("
") 中。
记为您提供了一种将多行指示为代码的方法。使用
应当用于描述类型成员。使用
以提供有关类型本身的信息。
description 说明。
path='tagpath[@name="id"]' /> filename 包含文档的文件名。该文件名可 东软集团有限公司 C#编程规范2.0 用路径加以限定。将 filename 括在单引号中 (' ')。 外的另一种可选方法。 Tagpath：filename 中指向标记名的标记路径。将此路径括在单引号中 (' ')。 name 注释前边的标记中的名称说明符；名称具有一个 id。 id 位于注释之前的标记的 id。将此 id 括在双引号中 (" ")。 "table"> 列表中的每一项用 term 也需要指编号列表，只需为 text 提供一个项。 列表或表所拥有的 text。但是，对于表、项目符号列表或 term 定义的项，该项将在 text 中定义。 description 目符号列表或编号列表中的项或者 term 的定义。 cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 转换为输出 XML 中的规范化元素名。必须将 cref="member">description description 成员的访问的说明。 description 成员的说明。 description 返回值的说明。 东软集团有限公司 C#编程规范2.0 property-description 属性的说明。 意，当在 Visual Studio .NET 开发环境中通过代码向导添加属性时，它将会为新属性添加 第四章 申明 4.1 每行声明数 一行只建议作一个声明，并按字母顺序排列。如 var level; //推荐 var size; //推荐 var x, y; //不推荐 4.2 初始化 建议在变量声明时就对其做初始化。 4.3 位置 变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。如 function myMethod() { var _count= 0; // beginning of method block if (condition) { var _initCount = 0; // beginning of "if" block ... } } 不过也有一个例外 for (var i = 0; i < maxLoops; i++) { ... } 应避免不同层次间的变量重名，如 东软集团有限公司 C#编程规范2.0 var _count; ... function myMethod() { if (condition) { var _count = 0; // 避免 ... } ... } 第五章 命名规范 5.1 命名概述 名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用 getNextStudent()，而不是 getNextArrayElement()。 命名原则是： 选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名称符合适用语言的规则和标准。 以下几点是推荐的命名方法。 1、避免容易被主观解释的难懂的名称，如方面名 analyzeThis()，或者属性名 xxK8。这样的名称会导致多义性。 2、在类属性的名称中包含类名是多余的，如 tle。而是应该使用 。 3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。 4、在变量名中使用互补对，如 min/max、begin/end 和 open/close。 5、布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFound。 6、在命名状态变量时，避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag，而是使用更具描述性的名称，如 documentFormatType。 （此项只供参考） 5.2 缩写 为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则： 1 不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用 getWindow，而不要使用 getWin。 2 不要使用计算机领域中未被普遍接受的缩写。 3 在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 缩 写，用 OLAP 作为 On-line Analytical Processing 的缩写。 4在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如，使用 HtmlButton 或 HTMLButton。但是，应当大写仅有两个字符的缩写，如，，而不是 东软集团有限公司 C#编程规范2.0 。 5 不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请 使用Camel 大小写，虽然这和单词的标准缩写相冲突。 5.3 表空间 1、 全部使用小写 2、 用名词或名词短语命名类 3、 使用mw.分类.具体类名。 如：with ($namespace("ls")) 5.4 类 1、使用 Pascal 大小写。 2、用名词或名词短语命名类。 3、使用全称避免缩写，除非缩写已是一种公认的约定，如URL、HTML 4、不要使用类型前缀，如在类名称上对类使用 C 前缀。例如，使用类名称 FileStream，而不是 CFileStream。 5、不要使用下划线字符 (_)。 6、声明类时需带上表空间。 如： with($namespace("")) { /// nary = function() { var me = this; /// = 0; var _internalDict = new ActiveXObject("nary"); var _values = new Array(); /// = function(p_key, p_value) { _(p_value); _(p_key, p_value); = _; } return me; } } 东软集团有限公司 C#编程规范2.0 5.5 属性 1、使用Camel 大小写。 2、用名词或名词短语命名类。 3、约定：内部受保护的属性使用下划线开头（_）. 如：_cursor表示是受保护的属性，外界不应该使用。 ox = function(p_container) { var me = new TextEditor(p_container, null); Type = "checkbox"; me._cursor = "default"; return me; } 5.6 参数 以下规则概述参数的命名指南： 在大多数情况下确定它的含义。 2、对参数名称使用 Camel 大小写。 3、以p_开头 以下是正确命名的参数的示例。 1、使用描述性参数名称。参数名称应当具有足够的描述性，以便参数的名称及其类型可用于 ue = function(p_value) { me._value = p_value; me._d = (me._value == hecked); } 5.7 方法 以下规则概述方法的命名指南： 1 使用动词或动词短语命名方法。 2 使用Camel大小写。 3 约定：类内部受保护的方法使用下划线开头（_）. 如：setValue(p_value),_createInput 5.8 事件 以下规则概述事件的命名指南： 1、对事件处理程序名称使用on开头。 2、事件处理程序都提供两个参数sender，args。 3、使用Before,After表示事件发生的时间顺序，如onBeforeSave,onAfterSave。 东软集团有限公司 C#编程规范2.0 4、一些事件可以用时态表示顺序，如onchange,onChanged 5、使用Camel大小写。 如： reSave = new Event(); 5.9 变量 1． 使用Camel大小写。 2． 用名词或名词短语命名类。 3． 类内部或函数内部使用的变量使用下划线开头（_）. 如：var _rowHead = $new("tbody"); 5.10 常量 以下规则概述常量的命名指南： 所有单词大写，多个单词之间用 "_" 隔开。 如 var PAGE_TITLE = "Welcome"; 第六章 语句 6.1 每行一个语句 每行最多包含一个语句。如 a++; //推荐 b--; //推荐 a++; b--; //不推荐 6.2 复合语句 复合语句是指包含"父语句{子语句;子语句;}"的语句，使用复合语句应遵循以下几点 1 子语句要缩进。 2 左花括号“{” 在复合语句父语句的下一行并与之对齐，单独成行。 3 即使只有一条子语句要不要省略花括号“ {}”。 如 if () { Event("onload", function() { if (ma == null) { Schema(); } }); } 东软集团有限公司 C#编程规范2.0 6.3 return 语句 return语句中不使用括号，除非它能使返回值更加清晰。如 return; return (); return (size ? size : defaultSize); 6.4 if、 if-else、if else-if 语句 if、 if-else、if else-if 语句使用格式 if (condition) { statements; } if (condition) { statements; } else { statements; } if (condition) { statements; } else if (condition) { statements; } else { statements; } 6.4 for 语句 for 语句使用格式 for (initialization; condition; update) { statements; 东软集团有限公司 C#编程规范2.0 } 注意 1在循环过程中不要修改循环计数器。 2对每个空循环体给出确认性注释。 6.5 while 语句 while 语句使用格式 while (condition) { statements; } 空的 while 语句使用格式 while (condition); 6.7. switch - case 语句 switch - case 语句使用格式 switch (condition) { case 1: statements; break; case 2: statements; break; default: statements; break; } 注意： 1、语句switch中的每个case各占一行。 2、语句switch中的case按字母顺序排列。 3、为所有switch语句提供default分支。 4、所有的非空 case 语句必须用 break; 语句结束。 东软集团有限公司 C#编程规范2.0 6.9. try - catch 语句 try - catch 语句使用格式 try { statements; } catch (e) { statements; } 6.10. with 块语句 using 块语句使用格式 with (object) { statements; }
版权声明：本文标题：js代码规范 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://www.freenas.com.cn/jishu/1704439479h459887.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。
发表评论