选课系统编码规范及其代码说明
目录
1.导言
1.1目的
1.2范围
1.3缩写说明
1.4术语定义
1.5引用标准
1.6参考资料
1.7版本更新信息
2. 编码格式规范
3.命名规范
3. 1命名的基本约定
3. 2各种标示符类型的命名约定
3. 3组件名称缩写列表
4．声明规范
4.1变量声明
4.2代码缩进
4.3空白
5．语句规范
6.注释规范
6. 1注释的方法
6. 2开头注释
6. 3类和接口的注释
7.目录规范
1.导言
1.1目的
该文档的目的是描述网上招聘系统项目的编码规范和对代码的说明，其主要内容包括：
●编码规范
●命名规范
●注释规范
●语句规范
●声明规范
●目录设置
●代码说明
本文档的预期的读者是：
●开发人员
●项目管理人员
●质量保证人员
1.2范围
该文档定义了本项目的代码编写规范，以及部分代码描述和所有代码的说明。
1.3缩写说明
Aspx
Aspx是Active Server Pages XML的缩写。
1.4术语定义
Class
C#程序的单元。
Packages
由很多的类组成的工作包。
1.5引用标准
[1] 《企业文档格式标准》
北京长江软件有限公司
1.6参考资料
书名：《系统分析设计技术》作者：张友生
《C#程序设计》
2. 编码格式规范
1．代码书写格式
（1）所有的缩进TAB键为4个空格，每个单词的首字符大写，其余小写。
（2）在代码中垂直对齐左括号和右括号。
例：
if(x==0)
{
Response.Write("用户名必须输入！");
}
不允许以下情况：
if(x==0)
{
Response.Write("用户名必须输入！");
}或者
if(x==0)
{
Response.Write("用户名必须输入！");
}
（3）在大多数运算符之前和之后使用空格，这样做时不会改变代码的的
意图却可以使代码容易阅读。例：int j = i + k;而不应写为：int j=i+k;
（4）缩写SQL语句时，对于关键字使用全部大写，对于数据库元素（如
表，列和视图）使用大小写混合）。
（5）将每个主要的SQL子句放在不同的行上，这样更容易阅读和编辑
语句。
2.注释的写法
（1）在你劳神的地方请加上详细的注释说明，除了最简单的存取成员变
量的Set/Get成员函数之外，其余大部分的函数写上注释是良好的习惯，尽量使你的程序让别人很容易看懂。
（2）大多的注释会使很难看，但一些复杂的算法和数据结构和数据结构处还是要加上注释的，这样别人就容易看懂，否则时间长了，你自己都未必卸载明白了。
（3）如果是对某一段程序（算法/结构）的注释，在程序头直接用//再空一格进行说明，一行不要超过80个字符。
（4）为了防止在阅读代码时不得不左右流动源代码编辑器，每行代码或注释在不得超过一显示屏。
（5）使用连续的多个/表示注释行（不要超过80字符）。
（6）文件头部应有注释，简单描述文件的内容（7）对于程序中的比较关键的算法和函数，必须加注释。
3．cs文件的书写
（1）各个部分应使用注释行和空行分割，并在必要的地方写上注释。（2）函数之间用注释各空行分割。中间的内容缩进一个TAB三.其他1.变量
(1)float和bool禁止用"=="判断.bool应该用逻辑运算关系符,而float应该用差值区间来判断"相等";
(2)类型转换一律用显示类型转换
(3)类型的长度一律用sizeof()获得;
(4)当声明一个变量时,务必要自已初始化一下变量;
2.函数
(1)功能单一,函数名要名符其实.
(2)要易懂,实现时要根过分追求技巧,优化放到后面去做
.(3)长度一般禁止超过200行.
(4)要检查输入值是否合法,实现(成员)函数时务必要求输入参数是在要求范围之内,尤其你定义的(成员)函数给别人调用时,要判断其合法性.
(5)调用函数时要严格按照接口规范调用,调用后要判断执行情况,并做适当的错误处理(尔后会给出错误和异常处理规范)
(6)尽量避免整块复制代码段,如果出现这样的情况要分析原因,如果这段代码完成独立的功能,应考虑使用函数,否则,应考虑使用宏定义,否则因为修改引起的不一致往往是错误的根源
.(7)除极其简单的函数外,其他的函数在稿处必须加上FMAT_TARCE(),参见错误异常处理规范
.(8)函数的出口尽量唯一,最好在出口处加上FMAT_TRCE();
(9)写代码时,尽量减少堆的分配次数,能使用Stack的尽量使用Stack
(10)函数编写必须精练,消除冗余的代码,删除不用的变量
(11)if/while等语句中和条件表达式的运算结果必须为显示的Bool量
(12)禁止使用goto语句附:标识符大小写方式示例标识符大小写规则标识符大小写示例类Pascal AppDomain 枚举类型Pascal ErrorLevel 枚举值Pascal FataError 事件Pascal ValueChanged 异常类Pascal WebException 只读的静态字段Pascal ReadValue 接口Pascal IDisposable 方法Pascal ToString 命名空间Pascal
System.Drawing 属性Pascal BackColor 参数Camel typeName 3.命名规范
3.1命名的基本约定
1> 要使用可以准确说明变量/字段/类的完整的英文描述符，如firstName。对一些作用显而易见的变量可以采用简单的命名，如在循环里的递增（减）变量就可以被命名为“i”。
2> 要尽量采用项目所涉及领域的术语。
3> 要采用大小写混合，提高名字的可读性。为区分一个标识符中的多个单词，把标识符中的每个单词的首字母大写。不采用下划线作分隔字符的写法。
有两种适合的书写方法，适应于不同类型的标识符：
PasalCasing：标识符的第一个单词的字母大写；
camelCasing：标识符的第一个单词的字母小写。
4> 下表描述了不同类型标识符的大小写规则：
5> 避免使用缩写，如果一定要使用，就谨慎使用。同时，应该保留一个标准缩写的列表，并且在使用时保持一致。
6> 对常见缩略词，两个字母的缩写要采用统一大小写的方式（示例：ioStream，getIOStream）；多字母缩写采用首字母大写，其他字母小写的方式（示例：getHtmlTag）；
7> 避免使用长名字（最好不超过15 个字母）。
8> 避免使用相似或者仅在大小写上有区别的名字。
3.2 各种标示符类型的命名约定
1> 程序集命名
实验室名称（Lab）+ 项目名称+ 模块名称（可选），例如：
中心服务器程序集：Lab.SeverCenter；
中心服务器业务逻辑程序集：Lab.SeverCenter.Business；
2> 命名空间命名
采用和程序集命名相同的方式：实验室名称（Lab）+ 项目名称+ 模块名称。另外，一般情况下建议命名空间和目录结构相同。例如：
中心服务器：Lab.SeverCenter；
中心服务器下的用户控件：https://www.doczj.com/doc/804763345.html,erControl；
中心服务器业务逻辑：Lab.SeverCenter.Business；
中心服务器数据访问：Lab.SeverCenter.Data；
3> 程序集和DLL
l 大多数情况下，程序集包含全部或部分可重用库，且它包含在单个动态链接库(DLL) 中。
l 一个程序集可拆分到多个DLL 中，但这非常少见，在此准则中也没有说明。
l 程序集和DLL 是库的物理组织，而命名空间是逻辑组织，其构成应与程序集的组织无关。
l 命名空间可以且经常跨越多个程序集。可以考虑如下模式命名DLL：
例：Lab.SeverCenter.dll
4> 类和接口命名
l 类的名字要用名词；
l 避免使用单词的缩写，除非它的缩写已经广为人知，如HTTP。
l 接口的名字要以字母I开头。保证对接口的标准实现名字只相差一个“I”前缀，例如对IComponent接口的标准实现为Component；
l 泛型类型参数的命名：命名要为T或者以T开头的描述性名字，例如：
public class List
public class MyClass
l 对同一项目的不同命名空间中的类，命名避免重复。避免引用时的冲突和混淆；
5> 方法命名
l 第一个单词一般是动词；
l 如果方法返回一个成员变量的值，方法名一般为Get+成员变量名，如若返回的值是bool 变量，一般以Is作为前缀。另外，如果必要，考虑用属性来替代方法；
l 如果方法修改一个成员变量的值，方法名一般为：Set + 成员变量名。同上，考虑用属性来替代方法。
6> 变量命名
l 按照使用范围来分，我们代码中的变量的基本上有以下几种类型，类的公有变量；类的私有变量（受保护同公有）；方法的参数变量；方法内部使用的局部变量。这些变量的命名规则基本相同，见标识符大小写对照表。区别如下：
a) 类的公有变量按通常的方式命名，无特殊要求；
b) 类的私有变量采用两种方式均可：采用加“m”前缀，例如mWorkerName;
c) 方法的参数变量采用camalString，例如workerName；
l 方法内部的局部变量采用camalString，例如workerName。
l 不要用_或&作为第一个字母；
l 尽量要使用短而且具有意义的单词；
l 单字符的变量名一般只用于生命期非常短暂的变量：i,j,k,m,n一般用于integer；c,d,e 一般用于characters；s用于string
l 如果变量是集合，则变量名要用复数。例如表格的行数，命名应为：RowsCount；
l 命名组件要采用匈牙利命名法，所有前缀均应遵循同一个组件名称缩写列表
3.3 组件名称缩写列表
缩写的基本原则是取组件类名各单词的第一个字母，如果只有一个单词，则去掉其中的元音，留下辅音。缩写全部为小写。
4.声明规范
4.1 变量声明：
为了保持更好的阅读习惯，请不要把多个变量声明写在一行中，即一行只声明一个变量。
例如：
String strTest1, strTest2;
应写成：
String strTest1;
String strTest2;
4.2代码缩进：
l 一致的代码缩进风格，有利于代码的结构层次的表达，使代码更容易阅读和传阅；
l 代码缩进使用Tab键实现，最好不要使用空格，为保证在不同机器上使代码缩进保持一致，特此规定C#的Tab键宽度为4个字符，设定界面如下(工具–选项)：
l 避免方法中有超过5个参数的情况，一般以2,3个为宜。如果超过了，则应使用struct来传递多个参数。
l 为了更容易阅读，代码行请不要太长，最好的宽度是屏幕宽度（根据不同的显示分辩率其可见宽度也不同）。请不要超过您正在使用的屏幕宽度。（每行代码不要超过80个字符。）
l 程序中不应使用goto语句。
l 在switch语句中总是要default子句来显示信息。
l 方法参数多于8个时采用结构体或类方式传递
l 操作符/运算符左右空一个半角空格
l 所有块的{}号分别放置一行，并嵌套对齐，不要放在同一行上
4.3空白：
l 空行将逻辑相关的代码段分隔开，以提高可读性。
l 下列情况应该总是使用两个空行：
a) 一个源文件的两个片段(section)之间。
b) 类声明和接口声明之间。
l 下列情况应该总是使用一个空行：
a) 两个方法之间。
b) 方法内的局部变量和方法的第一条语句之间。
c) 块注释（参见"5.1.1"）或单行注释（参见"5.1.2"）之前。
d) 一个方法内的两个逻辑段之间，用以提高可读性。
l 下列情况应该总是使用空格：
a) 空白应该位于参数列表中逗号的后面，如：
void UpdateData(int a, int b)
b) 所有的二元运算符，除了"."，应该使用空格将之与操作数分开。一元操作符和操作数之间不因该加空格，比如：负号("-")、自增("++")和自减("--")。例如：
a += c + d;
d++;
c) for 语句中的表达式应该被空格分开，例如：
for (expr1; expr2; expr3)
d) 强制转型后应该跟一个空格，例如：
char c;
int a = 1;
c = (char) a;
5.语句规范
C# 语言规范--1.6 语句：
C# 中的大多数语句都是直接从C 和C++ 借用的，但有一些值得注意的添加和修改。列出了可用的语句类型，并提供了每种类型的示例。
语句示例
语句列表和块语句static void Main()
{
F();
G();
{
H();
I();
}
}
标记语句和goto 语句
static void Main(string[] args) {
if (args.Length == 0)
goto done;
Console.WriteLine(args.Length); done:
Console.WriteLine("Done");
}
局部常数声明
static void Main() {
const float pi = 3.14f;
const int r = 123;
Console.WriteLine(pi * r * r);}
局部变量声明
static void Main()
{
int a;
int b = 2, c = 3;
a = 1;
Console.WriteLine(a + b + c);
}
表达式语句
static int F(int a, int b)
{
return a + b;}static void Main() {
F(1, 2); // Expression statement }
if 语句
static void Main(string[] args)
{
if (args.Length == 0)
Console.WriteLine("No args");
Else
Console.WriteLine("Args"); }
switch 语句
static void Main(string[] args)
{
switch (args.Length)
{
case 0:
Console.WriteLine("No args");
break;
case 1:
Console.WriteLine("One arg ");
break;
default:
int n = args.Length; Console.WriteLine("{0} args", n);
break;
}
}
while 语句
static void Main(string[] args)
{
int i = 0;
while (i < args.Length)
{
Console.WriteLine(args[i]);
i++;
}
}
do 语句
static void Main()
{ string s;
do
{
s = Console.ReadLine();
}
while (s != "Exit");
}
for 语句
static void Main(string[] args)
{
For
(int i = 0; i < args.Length; i++) Console.WriteLine(args[i]);
}
foreach
语句static void Main(string[] args)
foreach (string s in args)
Console.WriteLine(s);
}
break 语句
static void Main(string[] args)
{
int i = 0;
while (true)
{
if (i == args.Length)
break;
Console.WriteLine(args[i++]);
}
}
continue 语句
static void Main(string[] args)
{
int i = 0;
while (true)
{
Console.WriteLine(args[i++]);
if (i < args.Length)
continue;
break;
}
}
return 语句
static int F(int a, int b)
{
return a + b;
}
static void Main()
{ Console.WriteLine(F(1, 2)); return; }
throw 语句和try 语句
static int F(int a, int b)
{
if (b == 0)
throw new Exception("Divide by zero");
return a / b;
}
static void Main()
{
{
Console.WriteLine(F(5, 0));
}
catch(Exception e) {
Console.WriteLine("Error");
}
}
checked 和unchecked 语句
static void Main()
{
int x = Int32.MaxValue;
Console.WriteLine(x + 1);
// Overflow
checked
{
Console.WriteLine(x + 1);
// Exception }
unchecked {
Console.WriteLine(x + 1); // Overflow
}
}
lock 语句
static void Main()
{ A a = ...;
lock(a)
{
a.P = a.P + 1;
}
}
using 语句static void Main()
{
using (Resource r = new Resource())
{
r.F();
}
}
6.注释规范
C# 提供一种机制,使程序员可以使用含有XML 文本的特殊注释语法为他们的代码编写文档.在源代码文件中,具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成XML.使用这类语法的注释称为文档注释(documentation comment).这些注释后面必须紧跟用户定义类型(如类, 委托或接口)或者成员(如字段,事件,属性或方
法).XML 生成工具称作文档生成器(documentation generator). (此生成器可以但不一定必须是C# 编译器本身.)由文档生成器产生的输出称为文档文件(documentation file). 文档文件可作为文档查看器(documentation viewer) 的输入;文档查看器是用于生成类型信息及其关联文档的某种可视化显示的工具.
此规范推荐了一组在文档注释中使用的标记,但是这些标记不是必须使用的,如果需要也可以使用其他标记,只要遵循"符合格式标准的XML"规则即可.
A.1. 介绍
具有特殊格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成XML.这类注释是以三个斜杠(///) 开始的单行注释,或者是以一个斜杠和两个星号(/**) 开始的分隔注释.这些注释后面必须紧跟它们所注释的用户定义类型(如类,委托或接口)或者成员(如字段,事件,属性或方法).属性节(第错误!未找到引用源. 节)被视为声明的一部分,因此,文档注释必错误!未找到引用源. 须位于应用到类型或成员的属性之前. 语法: 语法:
single-line-doc-comment:
///
input-charactersopt
delimited-doc-comment:
/**
delimited-comment-charactersopt
*/
在single-line-doc-comment 中, 如果当前single-line-doc-comment 旁边的每个single-line-doc-comment 上的/// 字符后跟有whitespace 字符, 则此
whitespace 字符不包括在XML 输出中.
在delimited-doc-comment 中,如果第二行上的第一个非whitespace 字符是并且在delimited-doc-comment 内的每行开头都重复同一个由一个asterisk,
可选whitespace 字符和asterisk 字符组成的样式, 则该重复出现的样式所含的字符不包括在XML 输出中.此样式中,可以在asterisk 字符之前或之后包括whitespace 字符. 示例: 示例:
/// Class
文档注释内的文本必须根据XML 规则(https://www.doczj.com/doc/804763345.html,/TR/REC-xml) 设置正确的格式.如果XML 不符合标准格式,将生成警告,并且文档文件将包含一条注释,指出遇到错误. 尽管开发人员可自由创建它们自己的标记集,但第 A.2. 建议的标记节定义有建议的标记集.某些建议的标记具有特殊含义:
标记用于描述参数.如果使用这样的标记,文档生成器必须
验证指定参数是否存在以及文档注释中是否描述了所有参数.如果此验证失败, 文档生成器将发出警告.
cref 属性可以附加到任意标记,以提供对代码元素的参考.文档生成
器必须验证此代码元素是否存在.如果验证失败,文档生成器将发出警告.查找在cref 属性中描述的名称时,文档生成器必须根据源代码中出现的using 语句来考虑命名空间的可见性. 外信息.
标记表示应该包含的来自外部XML 文件的信息. 标记旨在标出可由文档查看器显示的有关类型或成员的额
注意,文档文件并不提供有关类型和成员的完整信息(例如,它不包含任何关于类型的信息).若要获得有关类型或成员的完整信息,必须协同使用文档文件与对实际涉及的类型或成员的反射调用.
A.2. 建议的标记
文档生成器必须接受和处理任何根据XML 规则有效的标记.下列标记提供了用户文档中常用的功能.(当然,也可能有其他标记.) 标记
章节A.2.1.
用途将文本设置为类似代码的字体将一行或多行源代码或程序输出设置为某种字体
A.2.3.
表示所含的是示例
A.2.4.
标识方法可能引发的异常
A.2.5.
包括来自外部文件的XML
A.2.6.
创建列表或表
A.2.7.
用于将结构添加到文本中
A.2.8.
描述方法或构造函数的参数
A.2.9.
确认某个单词是参数名
A.2.10.
描述成员的安全性和访问权限
A.2.11.
描述一种类型
A.2.12.
描述方法的返回值
A.2.13.
指定链接
A.2.14.
生成"请参见" 生成"请参见"项
A.2.15.
描述类型的成员描述类型的成员
A.2.16.
描述属性
A.2.1.
此标记提供一种机制以指示用特殊字体(如用于代码块的字体)设置说明中的文本段落.对于实际代码行,请使用(第 A.2.2. 节). 语法: 语法:
示例: 示例:
/// Class
public class Point { // …… }
A.2.2.
此标记用于将一行或多行源代码或程序输出设置为某种特殊字体. 对于叙述中较小的代码段,请使用
source code or program output
示例: 示例:
/// This method changes the point's location by /// the given x- and y-offsets. ///
A.2.3.
此标记用于在注释中插入代码示例,以说明如何使用所关联的方法或其他库成员.通常,此标记是同标记(第 A.2.2. 节)一起使用的.
语法: 语法:
示例: 示例: 有关示例,请参见(第A.2.2. 节).
A.2.4.
此标记提供一种方法以说明关联的方法可能引发的异常. 语法: 语法:
其中
cref="member"
成员的名称.文档生成器检查给定成员是否存在,并将member 转换为文档文件中的规范元素名称.
description
对引发异常的情况的描述. 示例: 示例:
public class DataBaseOperations { /// cref="MasterFileLockedOpenException"> public static void ReadRecord(int flag) { if (flag == 1) throw new MasterFileFormatCorruptException(); else if (flag == 2) throw new MasterFileLockedOpenException(); // … } } A.2.5. 此标记允许包含来自源代码文件外部的XML 文档的信息.外部文件必须是符合标准格式的XML 文档,还可以将XPath 表达式应用于该文档来指定应包含该XML 文档中的哪些XML 文本.然后用从外部文档中选定的XML 来替换 标记. 语法: 语法: 其中 file="filename" 外部XML 文件的文件名. 该文件名是相对于包含include 标记的文件进行解释的(确定其完整路径名). path="xpath" XPath 表达式,用于选择外部XML 文件中的某些XML. 示例: 示例: 如果源代码包含了如下声明: /// Contains a list of integers. 这样输出的文档就与源代码中包含以下内容时一样: /// /// Contains a list of integers. /// public class IntList { … } A.2.6. 此标记用于创建列表或项目表. 它可以包含 块以定义表或定义列表的标头行.(定义表时,仅需要在标头中为term 提供一个项.) 列表中的每一项都用一个块来描述.创建定义列表时,必须同时指定 term 和description.但是,对于表,项目符号列表或编号列表,仅需要指定description. 语法: 语法: 其中 term 要定义的术语,其定义位于description 中. description 是项目符号列表或编号列表中的项,或者是term 的定义. 示例: 示例: public class MyClass { /// Here is an example of a bulleted list: /// 上海亚东国际货运有限公司（企业标准） 信息分类与编码 （草案） 日期：2011年10月 目录 1、前言 2、范围 3、规范性应用文件 4、术语和定义 5、分类 6、编码 7、分类对象表示 8、分类编码表 1、前言 本标准由亚东总部办公会议提出，归口到亚东总部信息管理部。 标准起草部门：总经办、办公室、人力资源部、信息管理部。 标准起草人：劳渝声、张正良、孙海龙、沈锡鹤 2、范围 本标准规定了亚东物流信息的分类、编码及分类代码。 本标准适用于总部各级管理部门、分子公司以及相关单位对于物流信息的管理及应用。 3、规范性引用文件 下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的国标文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，亚东总部鼓励各部门及子分公司根据本标准使用这些国标文件的最新版本。凡是不注日期的引用国标文件，其最新版本适用于本标准。 GB/T 10113-2003 分类与编码通用术语 GB/T 23831-2009 物流信息分类与代码 4、术语和定义 下列术语和定义适用于本标准。 4.1 类 category 具有某种共同属性（或特征）的实物或概念的集合。 【引自GB/T 10113-2003，2.1.1】 4.2 分类 classification 按照选定的属性（或特征）区分分类对象（3.4），将具有某种共同属性（或特征）的分类对象（3.4）集合在一起的过程。 【引自GB/T 10113-2003，2.1.2】 4.3 信息分类 information classifying 把具有某种共同属性或特征的信息归并在一起，把具有不同属性或特征的信息区别开来的过程。 【引自GB/T 10113-2003,2.1.3】 4.4 分类对象 objects of classification 被分类（3.2）的事物或概念。 【引自GB/T 10113-2003,2.1.4】 4.5 线分类法 method of linear classification 将分类对象（3.4）按选定的若干属性（或特征），逐次地分为若干层级，每个层级又分为若干类目。同一分支的同层级类目之间构成并列关系，不同层级类目之间构成隶属关系。 【引自GB/T 10113-2003，2.1.5】 4.6 层次码 layer code 能反映编码对象为隶属关系的代码。 【引自GB/T 10113-2003，2.2.22】 5、分类 5.1 原则 本标准按物流信息的业务管理及应用所反映的属性分类，遵循以下原则：5.1.1科学性 选择物流信息最稳定本质属性或特征作为分类的基础和依据。 5.1.2系统性 将选定的物流信息的属性或特征按一定的排列顺序予以系统化，形成一个科学合理的分类体系。 5.1.3可扩延性 设置收容类目，并且在建立物流信息分类体系和代码编码中充分考虑今后的信息分类与代码的扩充、延拓和细化。 5.1.4兼容性 与相关标准的相关内容相兼容。 WEB前端代码规范 规范目的 为提高团队协作效率，便于后台人员添加功能及前端后期优化维护，输出高质量的文档，特制订此文档。本规范文档一经确认，前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后方可更改。 基本准则 符合web标准；语义化html；结构、表现、行为分离；兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。 文件规范 3.jsp文件命名：英文驼峰式命名，文件名.jsp。按实际模块需求命名。 4.css文件命名：英文驼峰式命名，文件名.css。共用base.css，首页index.css，其他 页面按实际模块需求命名。 5.js文件命名：英文驼峰式命名，文件名.js。共用common.js，其他依实际模块需求命 名。 html书写规范 1.文档类型声明及编码：统一为html5的声明类型；编码统一为 ，书写时利用IDE实现层次分明的缩进。 2.非特殊情况下css文件必须在信息分类与编码
(完整word版)WEB前端开发代码使用要求规范
11.语义化html，如标题根据重要性用h1-h6(同一页面只能有一个h1)，段落标记用p，列表 用ul，内联元素中不可嵌套块状元素。 12.尽可能减少div的嵌套层数。 13.在页面中尽量避免使用内嵌样式表，即在标签内使用style="…"。 14.以背景形式呈现的图片，尽量写入css样式中；重要图片必须加上alt属性； 15.特殊符号使用：尽可能使用代码替代：比如<(<)、>(>)、空格( )、&(&)、 ”（"）等等； 16.尽量避免使用过度复杂的HTML结构。 css书写规范 1.编码统一为utf-8。 2.为了避免一些浏览器兼容性问题以及增加样式重用性，每个页面必须引入base.css（详见 附件一），此文件不可随意修改。 3.class与id的使用：id是唯一的并是父级的，class是可以重复的并是子级的，所以id 仅使用在大的模块上，class可用在重复使用率高及子级中。 4.为JavaScript预留钩子的命名，请以js_起始，比如：js_hide，js_show。 5.class与id命名：使用英文命名，命名要语义化，简明化，但不要使用诸如first，last 之类的命名。使用驼峰式和下划线分隔相结合的命名规则，即命名应以父级加子级的命名规范，如：父级的类为simple 子级的类应该为simple_first，以此类推，但是尽量避免出现超过四级的类命名。 6.css属性书写顺序，建议遵循：自身属性-->布局定位属性-->文本属性-->其他属性。此条 可根据自身习惯书写，但尽量保证同类属性写在一起。
中国石化信息分类编码标准 Q/SH005-01-2006 设备分类标准与编码 （2006年试用版） 不作为正式发布 先由相关企业试用 2006年- 8月制订 2006年- 10月试用
目录 Q/SH005-01-2006 (1) 前言 (3) 设备分类标准及编码说明 (4) 一、编制目的 (4) 二、编制依据 (4) 三、适用范围 (4) 四、编码对象 (4) 五、术语定义 (4) 六、设备分类标准制定原则 (5) 七、设备分类标准说明 (5) 八、编码规则 (5) （一）编码规则 (5) （二）代码表结构 (6) 九、油品销售企业《设备分类标准》填报说明 (6)
前言 本标准内容包括：中国石化设备分类与编码 本标准由中国石化信息标准化领导小组提出并归口管理 本标准起草单位：中国石化股份有限公司生产经营管理部 中国石化股份有限公司信息部 石化盈科信息技术有限责任公司 本标准主要起草人： 本标准负责单位：中国石化股份有限公司设备编码组 本标准由中国石化信息标准化领导小组办公室组织专家审核
设备分类标准与编码说明 一、编制目的 本标准编制的目的是为了统一规范设备分类，统一编码，满足石化总部及上、中、下游设备管理和ERP集中建设的需要。 二、编制依据 1、中国石化23大类《设备分类与编码》（2002年版） 2、《石油天然气行业设备分类与编码》（第四版） 3、油品销售EAM分类 三、适用范围 “设备分类标准及编码”适用于中国石化股份公司本部及所属单位。 四、编码对象 设备分类编码对象为28大类1037小类的设备分类。 五、术语定义 1、工业管道系指企业、事业单位所属的用于输送工艺介质的工艺管道、公用工程管道及其他辅助管道。 2、公用管道系指城市或乡镇范围内的用于公用事业或民用的燃气管道和热力管道。 3、长输管道系指产地、储存库、使用单位间的用于输送商品介质的管道。
项目代码编程规范 1.应用范围 本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）JS代码、HTML代码及数据库设计均应遵守这个规范。同时，也可作为其它项目的参考。 2.设计类和方法 2.1. 创建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解，方法是指执行一个独立逻辑的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。 之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。 类应该用来将相关的方法组织在一起。 当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。 大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。 创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。 2.2. 创建松散连接和高度专用的方法 2.2.1.使所有方法都执行专门的任务 每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。 创建专用方法有许多好处。首先调试将变得更加容易。 2.2.2.尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法
QB ****公司企业标准 信息分类和编码 第3分册工程信息分类和编码 （初稿） 20XX-XX-XX 发布 20XX -XX -XX 发行 *****有限责任公司 发 布 ICS XXX 备案号XXX
目次 前言 (3) 引言 (4) 1范围 (5) 2规范性引用文件 (5) 3术语和定义 (5) 4分类原则和方法 (6) 4.1基本原则 (6) 4.2分类对象的层面划分 (6) 4.3工程信息分类 (7) 4.4工程信息整体框架 (8) 5编码方法 (9) 5.1基本原则 (9) 5.2码值 (9) 5.3代码组结构和层次 (10) 5.3.1交互定位码 (10) 5.3.2项目编码 (10) 5.3.3管理属性编码 (11) 5.3.4设计属性编码 (11) 5.3.5合同属性编码 (12) 5.3.6档案属性编码 (12) 5.3.7采购、财务、招标信息属性编码 (13) 5.3.8非项目信息编码 (13) 6分类与代码表 (14) 6.1非项目信息分类标识码(30301) (14) 6.2省电网公司及直属单位编码(30302) (14) 6.3工程项目建设管理单位代码(30303) (15) 6.4项目属性代码(30304) (18) 6.5综合指标(30305) (19) 6.6立项时间(30306) (20) 6.7批次项目标识码(30307) (21) 6.8信息属性码分类(30308) (21) 6.9项目阶段代码((30309) (22) 6.10工作分解代码(30310) (22) 6.11信息创建部门代码(30311) (23) 6.12设计资料分类代码(30314) (24) 6.13设计阶段代码(30315) (24) 6.14类目代码(30316) (25)
Web前端开发规范手册 一、规范目的 1.1 概述 (1) 二、文件规范 2.1 文件命名规则 (1) 2.2 文件存放位置 (2) 2.3 css 书写规范 (3) 2.4 html书写规范 (7) 2.5 JavaScript书写规范 (11) 2.6 图片规范 (12) 2.7 注释规范 (13) 2.8 css 浏览器兼容 (13) 一、规范目的 1.1 概述 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后可以更改此文档. 二、文件规范 2.1 文件命名规则 文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符；命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。
a. HTML的命名原则 引文件统一使用index.htm index.html index.asp文件名（小写） 各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如： 关于我们\ aboutus 信息反馈\ feedback 产品\ product 如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示； 每一个目录中应该包含一个缺省的html 文件，文件名统一用index.htm index.html index.asp； b. 图片的命名原则 图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质 例如：广告、标志、菜单、按钮等等。 放置在页面顶部的广告、装饰图案等长方形的图片取名：banner 标志性的图片取名为：logo 在页面上位置不固定并且带有链接的小图片我们取名为button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu 装饰用的照片我们取名：pic 不带链接表示标题的图片我们取名：title 范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg 鼠标感应效果图片命名规范为"图片名+_+on/off"。 例如：menu1_on.gif menu1_off.gif c. javascript的命名原则 例如：广告条的javascript文件名为ad.js 弹出窗口的javascript文件名为pop.js d. 动态语言文件命名原则 以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。 范例：register_form.asp register_post.asp topic_lock.asp 2.2 文件存放位置规范 _Root cn 存放中文HTML文件 en 存放英文HTML文件 flash 存放Flash文件 images 存放图片文件 imagestudio 存放PSD源文件 flashstudio 存放flash源文件 inc 存放include文件 library 存放DW库文件 media 存放多媒体文件 project 存放工程项目资料
中船重工船业有限公司工程项目编码规则及管理办法 1. 范围 本办法规定公司各种工程编码分类和编码实施规则及其管理办法。 本规则适用于公司内部所有工程项目的编码计划编制、领发料、财务核算、计算机信息处理等。 2. 工程编码类别及其编制规则说明 2.1工程编码类别分为船舶产品工程、非船产品工程、基建工程、自营工程、设备大修、设备维修、设备技改、安全设施及其它工程。 2.2产品工程编码的编制方法 2.2.1 大吨位运输船舶（千吨位以上）工程号的编制方法 2.2.1.1 编码共6 位。前两位为船舶产品载重吨位或承载体积前两位数；第三位为同载重吨位船舶型号，无型号用0 表示，有型号时分为Ⅰ型、Ⅱ型、Ⅲ型等，分别用1、2、3表示，以此类推；第四、五、六位为公司大吨位运输船舶接单顺序号。 2.2.1.2 图示
例如：公司接单第31 艘70000 吨散货船工程编码为：700031 。 公司接单第18 艘33000 吨散货Ⅰ型船工程编码为：331018 。 2.2.2 商务船工程号的编制办法 2.2.2.1 编码共6位。前两位统一名称为SW（商务）；第三、四两位为商务船的长度，五、六两位为商务船接单顺序号。 2.2.2.2 图示 例如：公司接单第1 艘35 米长的商务船，工程号为：SW3501 2.2.3 小吨位（百吨位）运输船工程号的编制办法 2.2. 3.1 编码共6 位。前两位统一名称为YS（运输）；第三、四两位为运输船的吨位前两位，五、六两位为公司小吨位运输船接单顺序号。 2.2. 3.2 图示 例如：公司接单第1 艘载重吨为20 吨的运输船，工程号：YS2001
四、分类编码 (1)国民经济行业 代码行业分类 农林牧渔业 0101 农业 0102 林业 0103 畜牧业 0104 渔业 0105 农、林、牧、渔服务业 采矿业 0206 煤炭开采和洗选业 0207 石油和天然气开采业 0208 黑色金属矿采选业 0209 有色金属矿采选业 0210 非金属矿采选业 0211 其他采矿业 制造业 0313 农副食品加工业 0314 食品制造业 0315 饮料制造业 0316 烟草制品业 0317 纺织业 0318 纺织服装、鞋、帽制造业 0319 皮革、毛皮、羽毛(绒)及其制品业 0320 木材加工及木、竹、藤、棕、草制品业0321 家具制造业 0322 造纸及纸制品业 0323 印刷业和记录媒介的复制 0324 文教体育用品制造业 0325 石油加工及煤焦及核燃料加工业 0326 化学原料及化学制品制造业 0327 医药制造业 0328 化学纤维制造业 0329 橡胶制品业 0330 塑料制品业 0331 非金属矿物制品业 0332 黑色金属冶炼及压延加工业 0333 有色金属冶炼及压延加工业 0334 金属制品业 0335 通用设备制造业 0336 专用设备制造业 0337 交通运输设备制造业 0339 电气机械及器材制造业 0340 通信设备、计算机及其他电子设备制造业0341 仪器仪表及文化、办公用机械制造业0342 工艺品及其他制造业 0343 废弃资源和废旧材料回收加工业 电力、煤气及水的生产和供应业 0444 电力、热力的生产和供应业 0445 煤气生产和供应业 0446 水的生产和供应业建筑业 0547 房屋和土木工程建筑业 0548 建筑安装业 0549 建筑装饰业 0550 其他建筑业 交通运输仓储和邮政业 0651 铁路运输业 0652 道路运输业 0653 城市公共交通业 0654 水上运输业 0655 航空运输业 0656 管道运输业 0657 装卸搬运及其他运输服务业0658 仓储业 0659 邮政业 信息传输、计算机服务和软件业0760 电信和其他信息传输服务业0761 计算机服务业 0762 软件业 批发和零售业 0863 批发业 0865 零售业 住宿和餐饮业 0966 住宿业 0967 餐饮业 金融业 1068 银行业 1069 证券业 1070 保险业 1071 其他金融活动 房地产业 1172 房地产业 租赁和商务服务业 1273 租赁业 1274 商务服务业 居民服务和其他服务业 1582 居民服务业 1583 其他服务业 2100 其他行业 (2)企业登记注册类型 代码分类 内资企业 110 国有企业 120 集体企业
密级：内部1引言 (2) 1.1编写目的 (2) 1.2变更记录 (2) 1.3定义 (2) 1.4参考资料 (2) 2HTML (2) 2.1命名 (2) 2.2标签 (3) 2.3排版 (3) 2.4CSHTML (3) 3JS (3) 3.1组织 (3) 3.2命名 (4) 3.3变量 (4) 3.4方法 (4) 3.5对象及控件 (4) 3.6第三方库 (4) 3.7排版 (4) 3.8AJAX (5) 4CSS (5) 4.1组织 (5) 4.2命名 (5) 4.3兼容性 (5) 4.4第三方库 (6) 4.5排版 (6)
前台编码规范 1引言 1.1编写目的 帮助开发团队形成一致的前台编码风格，并指出某些容易引发BUG的不良编码习惯，预期读者为长沙安晨信息科技有限公司的全体开发人员。 1.2变更记录 版本号作者日期备注 1.0Aaron7/1/2014 1.1Aaron7/31/2014Add examples 1.2Aaron8/4/2014Update the format 1.3定义 术语定义备注 HTML Hypertext Markup Language JS Javascript CSS Cascading Style Sheet 1.4参考资料 2HTML 2.1命名 文件名采用帕斯卡命令法，所有单词首字母大写，词汇缩小可以全部大写，单词间不加任何连接符。例如“UserLogin.cshtml”
?文件名应见名知义，能清晰描述页面主要功能，例如“AddUser.cshtml”。 2.2标签 ?所有标签都应该正确关闭，例如“