XML代码规范

XML代码规范文档标志产品或者项目名字开发规范文档名字JAVA代码规范文档根目录 版本号1.0状态草稿 文档历史修订记录版本日期描述作者0.12006-7-4创建崔超文档审批记录姓名签字日期文档发布控制拷贝接收者组织1文件组织21.1 文件说明头21.2 文件创建注释21.3 元素及属性声明22注释要求22.1 元素注释要求32.2 属性注释要求33. 元素(Element)命名规则34. 属性(Attribute)命名规则和格式45代码风格55.1 代码样式55.2 缩进55.3 页宽51 文件组织 一个文件只能容纳一个特定功能的配置信息。不同的功能模块应当分开成多个文件配置。而且文件名采用英文小写中间用-（中横线）连接。如：algorithm-config.xml、xwork-workflow.xml等等。一个文件的组织形式如下：文件说明头文件创建注释元素及属性声明1.1 文件说明头首先引入xml的版本信息和该xml文件相应所需要的dtd文件或xml schema文件。如xwork的配置文件为：1.2 文件创建注释样例如下： 文件创建注释分两部分：一是版权信息。二是创建的文件以及创建时间和创建者，建议使用真实姓名。1.3 元素及属性声明按照相应类型的xml配置文件的要求（即其dtd或xml shcema要求的格式）进行配置即可。如java下标准的web配置文件web.xml其配置格式为：2 注释要求2.1 元素注释要求 注释应当位于元素之前和之后，把该元素的标签包括在内。 注释采用尖括号对。其中间添加注释，其余用“=”填充。例如：expertPerform.actionlogin.jsp 如元素的创建日期和该文件的创建日期相同且为同一个创建者则不需要添加创建日期信息和创建者信息。如不是，则需要加上。例如：mathAbilityTraining.actionmathEfficiencyTraining.action 任何对该基本功能元素的修改（包括对该元素包含属性的修改和子元素的修改）需要在元素首的注释后，另起一行加上注释，注释的内容包括修改者姓名，修改日期，修改内容的纲要介绍（不再需要用=来填充其余的空间）。添加的注释与上一行注释应当有相同的缩进格数。注：基本功能元素是指在相应的工具、框架、类库、自定义等等所对应的配置文件中该元素以及其自元素能完整的描述一个特定的功能。相对应的是最底层的元素是无法描述一个相对独立完整的功能的。例如：TrainingDispatcher基本功能元素举例：Hibernate类映射配置文件中的class、property元素。Spring bean配置文件中的bean元素。Webwork xwork配置文件中的interceptor、action、include、result-type元素。Java web部署描述符文件（web.xml）中的context-param、filter、listener、servlet元素。2.2 属性注释要求原则上，不要对属性进行注释，其注释随同其所在的元素放在一起。3 元素(Element)命名规则元素名使用英文全称，且首字母小写，以后个单词字母大写。对于需要用复数表达的元素名可在其名称后加后缀-s。4 属性(Attribute)命名规则和格式 属性名使用英文全称，且首字母小写，以后个单词字母大写。对于需要用复数表达的元素名可在其名称后加后缀-s 5 代码风格5.1 代码样式代码应该用 unix 的格式，而不是 windows 的（比如：回车变成回车+换行）5.2 缩进缩进应该是4个空格. 不要在源文件中保存Tab字符. 在编辑器中，选择将tab替换成4空格。5.3