当前位置：文档之家› 开发人员手册(VSNET开发规范篇)

开发人员手册(VSNET开发规范篇)

开发人员手册(VSNET开发规范篇)
开发人员手册(VSNET开发规范篇)

密级：秘密

开发人员手册

https://www.doczj.com/doc/6c10629068.html,开发规范篇

文档最后修订者及日期：

孙立新

2009-3-16

本版文件批准人及日期：

浪潮集团山东通用软件有限公司

目录

1导言 (5)

1.1目的 (5)

1.2适用范围 (5)

1.3术语定义 (5)

1.4参考资料 (5)

1.5版本更新记录 (5)

2使用的开发工具： (6)

3程序源代码风格定义 (6)

3.1代码结构风格 (6)

3.2注释风格 (7)

3.2.1单行注释 (8)

3.2.2多行注释 (8)

3.2.3文档型注释 (8)

3.2.4文档型注释规范 (10)

3.3代码书写风格 (14)

3.3.1缩进 (14)

3.3.2空行 (15)

3.3.3换行 (15)

3.3.4空格 (16)

3.3.5花括号 (16)

4命名规范 (17)

4.1大写规则 (17)

4.2区分大小写 (18)

4.3缩写 (19)

4.4措词 (20)

4.5避免类型名称混淆 (21)

4.6命名空间命名规范 (22)

4.7类命名规范 (24)

4.8接口命名规范 (24)

4.9属性命名规范 (25)

4.10枚举类型命名规范 (25)

4.11静态字段命名规范 (26)

4.12参数命名规范 (30)

4.13方法命名规范 (29)

4.14属性命名规范 (27)

4.15事件命名规范 (30)

4.16数据库对象命名规范 (31)

4.16.1数据库名（开发过程中） (31)

4.16.2数据库表 (32)

4.16.3字段 (32)

4.16.4存储过程命名约定 (33)

4.16.5触发器（插入，更新，删除）命名约定 (33)

4.16.6视图命名约定 (33)

4.16.7自定义数据类型命名约定 (34)

4.16.8自定义函数命名约定 (35)

4.17数据库表结构设计规范 (35)

4.18数据库存储过程编写规范 (36)

5界面规范 (37)

5.1总则 (37)

5.2遵从原则 (37)

5.3色彩搭配 (37)

5.4屏幕大小 (37)

5.5主控页面 (37)

5.5.1主页：登录窗口 (37)

5.5.2主操作页分成三个区域：标题菜单区、系统管理区、操作区 (38)

5.5.3浏览器 (39)

5.6各种页面模板应用的场景 (39)

5.6.1字典类 (39)

5.6.2单据类 (41)

5.6.3管理类 (42)

5.6.4索引类 (43)

5.6.5Tab页类 (43)

5.6.6响应式窗口类 (43)

5.6.7查询结果/报表类 (43)

6提示信息规范 (43)

6.1总则 (43)

6.2提示信息 (43)

7热键定义、帮助及使用规范 (44)

7.1总则 (44)

7.2规范 (44)

8单元测试规范（从开发人员角度） (45)

8.1总则 (45)

8.2测试规范 (45)

9配置管理规范（从开发人员角度） (46)

9.1总则 (46)

9.2开发前的准备 (46)

9.3开发过程中的规则 (46)

10程序模板 (47)

10.1总则 (47)

10.2字典模板 (47)

10.3单据模板 (48)

10.4查询模板 (48)

11其他规则及建议 (49)

1导言

1.1目的

本文档是为基于Microsoft?公司的Visual Studio .Net? - C#.Net系列开发工具进行软件开发的一个规范性文件。其目的是：

?保证软件开发过程中有一个统一的标准可以进行参照：包括类库、公共接口、设计模式、命名规范等。

?能够合理的使用公用资源

1.2适用范围

本文档主要是基于目前三层架构开发模式中的SmartClient方式进行描述的，并同样适合于传统的三层架构：https://www.doczj.com/doc/6c10629068.html,/BusinessIntegration/Database。

1.3术语定义

可访问性修饰符：public（公有）、internal（内部公有）、proected（受保护）、protected internal（受保护或内部公有）、private（私有）。在此约定好中英文对照名称。

非私有包括：公有、内部公有、受保护、受保护或内部公有。

1.4参考资料

1.《C# Language Specification1.

2.doc》

2.《C# Language Specification 2.0.doc》

1.5版本更新记录

2使用的开发工具：

?Microsoft? Visual Studio .Net 2005? - C#.Net

3程序源代码风格定义

源代码风格规范是在编写源代码文件时，对于书写格式和规则的统一要求。

编写源代码最基本的目标是能够经过编译生成可执行程序。此外，源代码的另一个主要目标是为了阅读，源代码不仅仅是为了编译器能够读懂，同时也是为了人能够读懂，且易于读懂。这就如写文章的句读、段落、章节等类似，如果没有一种良好的书写风格和习惯，不仅仅会使写出的文章难以阅读，而且可能会造成不少曲解。有句话叫“文如其人”，代码也同样是“文如其人”。

此外，作为一个协作密切的开发团队，非常有必要保持一致的代码书写风格，它有助于团队开发保持高效（沟通交流、代码阅读、工作交接、工作延续性等方面）。

3.1代码结构风格

对于每一个代码文件（*.cs），它的内容分为如下两个部分：

◆使用的命名空间

◆类型定义

使用的命名空间，要求必须都声明在代码文件的最前方。建议.net framework 中定义的命名空间放在最上面，然后根据与当前代码关系的远近依次排列，对于引用的命名空间，按照引用来源分段列示，段与段之间用空行分隔。示例图如下：

在类型定义部分，一个代码文件原则上只包含一个如下类型的定义：类、接口、结构、枚举。这样有利于构造出条理清晰的代码文件结构，一目了然。对于委托的定义，可考虑在一个代码文件中集中定义内聚度较高的一类枚举。

对于类的定义，按照一下顺序定义：

◆常量

◆字段

◆构造函数

◆析构函数

◆属性

◆方法

◆事件

所有的类成员必须显式的声明访问修饰限定符（public、internal、protected、private）。为使类型具有良好的封装性，其中字段类型只能声明为private。

对于接口和结构体定义，其成员声明顺序与类定义相同。

每行代码只允许写一条语句。每行代码写多条语句往往会造成调试定位、注释以及阅读的困难。

3.2注释风格

传统的注释风格：单行注释符号“//”和多行注释符号“/* */”在C#中依然可以使用。在.NET中，提供了额外的XML文档注释标记（Tags for

Documentation Comments）。

3.2.1单行注释

单行注释，即形式为“//”的注释。单行注释用于方法内的代码注释。如对局部变量声明的注释或代码行、代码段的注释。单行注释可单独一行，如果仅仅针对一句注释，且不影响换行，可放于代码行后部。

单行注释也可以用于临时屏蔽不用的代码行，在开发完毕后应及时清理。

特殊的，单行注释用于代码文件声明的注释，见代码文件注释。

3.2.2多行注释

多行注释，即形式为“/* */”的注释。一般的，不建议在代码中使用多行注释。多行注释可用于临时屏蔽不用的代码行，在开发完毕后应及时清理。

3.2.3文档型注释

文档型注释，即XML文档注释标记（Tags for Documentation Comments），该类注释是.Net定义的Xml标签，在声明接口、类、方法、属性、字段都应该使用该类注释，除了在阅读代码时了解代码语义之外，可通过该类注释生成代码类库的帮助文档（*.chm）。这些标记包括如下表的全部内容：

(完整word版)WEB前端开发代码使用要求规范

WEB前端代码规范 规范目的 为提高团队协作效率，便于后台人员添加功能及前端后期优化维护，输出高质量的文档，特制订此文档。本规范文档一经确认，前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后方可更改。 基本准则 符合web标准；语义化html；结构、表现、行为分离；兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。 文件规范

3.jsp文件命名：英文驼峰式命名，文件名.jsp。按实际模块需求命名。 4.css文件命名：英文驼峰式命名，文件名.css。共用base.css，首页index.css，其他 页面按实际模块需求命名。 5.js文件命名：英文驼峰式命名，文件名.js。共用common.js，其他依实际模块需求命 名。 html书写规范 1.文档类型声明及编码：统一为html5的声明类型；编码统一为 ，书写时利用IDE实现层次分明的缩进。 2.非特殊情况下css文件必须在...之间引入，选择link方式引入而非 @import形式。 3.非特殊情况下js文件必须在页面底部引入。 4.引入样式文件或JavaScript文件时，须略去默认类型声明，写法如下：

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属性书写顺序，建议遵循：自身属性-->布局定位属性-->文本属性-->其他属性。此条 可根据自身习惯书写，但尽量保证同类属性写在一起。

Web前端开发规范手册参考

Web前端开发规范 参考手册 一、规范目的 1.1 概述 为提高团队协作效率，便于后台人员添加功能，及前端后期优化维护，输出高质量的文档，特制订此文档。本规范文档一经确认，前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更改。 1.2 基本准则 符合web标准，语义化HTML，结构表现行为分离，兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。 二、规范细则 2.1 文件命名规则 文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符。命名原则的指导思想： ●一是使得工作组的每一个成员能够方便的理解每一个文件的意义。 ●二是当在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一 起，以便查找、修改、替换、计算负载量等等操作。 1. HTML命名原则 ●引导文件统一使用index.htm、index.html、ndex.asp文件名（小写）。 ●各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如： ?关于我们\ aboutus ?信息反馈\ feedback ?产品\ product ●如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音 的首字母表示；每一个目录中应该包含一个缺省的html 文件，文件名统一用 index.htm、index.html、index.asp。

2. 图片命名原则 ●图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。例如： 广告、标志、菜单、按钮等。 ●放置在页面顶部的广告、装饰图案等长方形的图片取名：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 3. Javascript命名原则 例如： ●广告条的javascript文件名为ad.js ●弹出窗口的javascript文件名为pop.js 4. 动态语言文件命名原则 以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。例如：register_form.asp register_post.asp topic_lock.asp 2.2 文件存放位置规范 HTML、CSS、js、images文件均归档至<系统开发规范>约定的目录中。 _Root cn 存放中文HTML文件 en 存放英文HTML文件 flash 存放Flash文件 images 存放图片文件 imagestudio 存放PSD源文件

前端开发设计规范文档样本

前端开发设计规范 目录 前端开发设计规范 (1) 一、HTML使用规范 (1) 1.1、页面文件命名规范 (1) 1.2、页面head部分书写规范 (1) 1.3、HTML元素开发规范 (2) 1.3.1、HTML元素书写规范 (2) 1.3.2、HTML元素命名规范 (4) 二、WEB页面开发规范 (5) 2.1、错误跳转页面的处理 (5) 2.2、提示信息的处理 (5) 2.3、页面的返回 (5) 2.4、提交前数据的判断验证 (5) 2.5、删除操作 (6) 2.6、页面中java代码的使用 (6) 2.7、网站页面布局规范 (7) 2.7.1、前台页面尺寸 (7)

2.7.2、标准网页广告图标规格（参考） (7) 2.7.3、页面字体 (8) 2.7.4、字体颜色 (8) 三、javaScript开发规范 (9) 3.1、javaScript文件命名规范： (9) 3.2、javaScript开发规范 (9) 3.2.1、javaScript书写规范 (9) 3.2.2、javaScript命名规范 (10) 四、css样式规范 (12) 4.1、css样式文件命名规范 (12) 4.1.1、通用样式文件命名规范： (12) 4.1.2、业务类样式文件命名规范 (13) 4.1.3、css样式文件命名须知 (13) 4.2、css样式文件存放目录规范 (13) 4.3、css样式定义规范 (14) 4.3.1、css样式内容顶部注释规范 (14) 4.3.2、css样式内容注释规范 (14) 4.3.3、css样式定义规范 (15) 4.3.4、css样式常用id的命名 (17) 4.3.5、css样式常用class的命名 (18)

Web前端开发规范手册

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 存放工程项目资料

设计手册

第一章设计要求 设计家庭清洁机器人的工作内容和要求：运行机构形式：轮式最高行进速度： 0.5m／ s 转弯半径:0 高度:<100mm 宽度:<400mm 清洁方式：吸尘、扫刷 一次充电连续工作时间： 0.5小时 营示方式： LED闪光 具有自动路径规划避障功能 具确自动充电装置 第二章家庭清洁机器人的关键技术 家庭清洁机器人的关键技术吸尘机器人系统通通常由四个部分组成：移动机构、感知系统、控制系统和吸尘系统。移动机构是吸尘机器人的主题，决定了吸尘器的运动空间，一般采用轮式机构。感知系统一般采用超声波测距仪、接触和接近觉传感器、红外线传感器和 CCD摄像机等。 目前发展较快、对吸尘机器人发展影响较大的关键技术是：传感技术，智能控制技术、路径规划技术、吸尘技术、电源技术等 2. 1传感技术 为了让吸尘机器人正常工作，必须对机器人位置、姿态、速度和

系统内部状态进行监控，还要感知机器人所出工作环境的静态和动感信息，使得吸尘机器人相应的工作顺序和操作内容能自然地适应工作环境的变化。 通常采用的传感器分为内部传感器和外部传感器。其中内部传感器有：编码器、线加速度计、陀螺仪、磁罗盘等。其中编码器用于确定当前机器人的位置，线加速度计获取线加速度信息，进而得到线加速度和位置信息；陀螺仪测量移动机器人的角度、角速度、角加速度以得到机器人的姿态角、运动方向和转动时运动方向的改变等绝对航向信息。外部传感器有视觉传感器、超声波传感器、红外传感器、接触很接近传感器。视觉传感器采用 CCD摄像机进行机器人的视觉导航与定位、目标识别和地图构造等；超声波传感器测量机器人工作环境中障碍物的距离信息和地图构造等。红外线传感器大多采用红外接近开关来探测机器人工作环境中的障碍物以及避免碰撞。接触和接近觉传感器多用于避碰规划。 2. 2路径规划技术 根据机器人对环境信息知道的程度不同，可分为为两种类型：环境信息完全知道的全局路径规划和环境信息完全未知或部分未知，通过传感器在线地对机器人的工作环境进行探测，以获取障碍物的位置、形状和尺寸等信息的局部路径规划。全局路径规划包括环境建模和路径搜索策略两个子问题。其中环境建模的主要方法有：可视图法（V‐Graph）、自由空间法(Free spaccApproach)和栅格法(Grids)等

ios开发规范文档

命名 命名规则对于维护代码来说是非常重要的,。Objective-C方法名往往很长，不过这也有好处，让很多注释变得毫无意义。 本文推荐驼峰法，也是Objective-C社区的标准。 驼峰法分小驼峰法和大驼峰法。小驼峰法：除第一个单词之外，其他单词首字母大写。大驼峰法相比小驼峰法，大驼峰法把第一个单词的首字母也大写了。 1.基本原则 1.1 清晰 又清晰又简洁是最好的了，但简洁不如清晰重要。总的讲不要使用单词的简写，除了非常常用的简写以外，尽量使用单词全称。API的名称不要有歧义，一看你的API就知道是以什么方式做了什么事情，不要让人有疑问 1.2 一致性 做某个事情代码通常都叫这个名字，比如tag、setStringValue，那么你也这么叫。你在不确定怎么起名字的时候，可以参考一些常用的名字：Method Arguments 2. 类命名 类名(不包括类别和协议名)应该用大写开头的大驼峰命名法。类名中应该包含一个或多个名词来说明这个类（或者类的对象）是做什么的。 在应用级别的代码里，尽量不要使用带前缀的类名。每个类都有相同的前缀不能提高可读性。不过如果是编写多个应用间的共享代码，前缀就是可接受并推荐的做法了(型如MBAPhotoBrowser )。 示例1： @interface ImageBrowseView :UIView @end 示例2：（带前缀MBA） @interface MBAPhotoBrowser :UIView @end

3. 类别命名 类名+标识+扩展（UIImageView +HP+Web） 例：如果我们想要创建一个基于UIImageView的类别用于网络请求图片，我们应该把类别 放到名字是UIImageView+HPWeb.h的文件里。UIImageView为要扩展的类名，HP为专属标识，Web为扩展的功能。 类别的方法应该都使用一个前缀(型如hp_myCategoryMethodOnAString ),以防止Objective- C代码在单名空间里冲突。如果代码本来就不考虑共享或在不同的地址空间(address- space)，方法命名规则就没必要恪守了。 类别HPWeb头文件，UIImageView+HPWeb.h如下： @interface UIImageView (HPWeb) - (void)hp_setImageWithURLString:(NSString *)urlStr; @end 4. 方法命名 方法使用小驼峰法命名, 一个规范的方法读起来应该像一句完整的话，读过之后便知函数 的作用。执行性的方法应该以动词开头，小写字母开头，返回性的方法应该以返回的内容 开头，但之前不要加get。 示例： - (void)replaceObjectAtIndex:(NSUInteger)index withObject:(id)anObject; (instancetype)arrayWithArray:(NSArray *)array;

Web前端开发规范手册

Web前端开发规范手册 修订历史记录 日期版本说明作者 2012年12月31日 1.0初稿施昀 2012年01月05日 1.1施昀、戴静2012年01月07日 1.2施昀 目录 修订历史记录 (1) 一、规范目的 (2) 1.1概述 (2) 二、基本准则 (2) 三、文件规范 (3) 2.1文件命名规则 (3) 2.1.1HTML的命名原则 (3) 2.1.2图片的命名原则 (3) 2.1.3.javascript的命名原则 (4) 2.1.4动态语言文件命名原则 (4) 2.2文件存放位置规范 (4) 2.3CSS书写规范 (4) 2.3.1基本原则 (4)

2.3.2注意细则 (5) 2.3.3命名规则 (6) 2.4html书写规范 (9) 2.4.1head区代码规范 (9) 2.4.2body区代码规范 (10) 2.5JavaScript书写规范 (10) 2.6图片规范 (10) 2.7注释规范 (11) 2.7.1html注释 (11) 2.7.2css注释 (11) 2.7.3JavaScript注释 (11) 四、执行模式 (12) 一、规范目的 1.1概述 提高团队协作效率 便于前端开发以及后期优化维护 方便新进的成员快速上手 输出高质量的代码 本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更新此文档。 二、基本准则 符合web标准,语义化html,结构表现行为分离,兼容性优良。 代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度。

开发时需要遵循如上基本准则，特殊情况可以有所宽限，如一些老项目的页面改造。 三、文件规范 2.1文件命名规则 [使用场景：在新建网页、图片、脚本、CSS文件时，根据此规则给文件命名并放入指定位置] 文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字空格和特殊字符。命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。 2.1.1HTML的命名原则 索引文件统一使用index.htm index.html index.asp文件名。 如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示。 每一个目录中应该包含一个缺省的html文件，文件名统一用index.htm index.html index.asp。 2.1.2图片的命名原则 图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。 例如：广告、标志、菜单、按钮等等。 放置在页面顶部的广告、装饰图案等长方形的图片取名：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

WEB前端开发规范文档+CSS命名规范

WEB前端开发规范文档+CSS命名规范 规范目的 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改. 基本准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度. 文件规范 1. html, css, js, images文件均归档至<系统开发规范>约定的目录中; 2. html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面; 3. css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.; 4. Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求命名. html书写规范 1. 文档类型声明及编码: 统一为html5声明类型; 编码统一为, 书写时利用IDE实现层次分明的缩进; 2. 非特殊情况下样式文件必须外链至...之间;非特殊情况下JavaScript文件必须外链至页面底部; 3. 引入样式文件或JavaScript文件时, 须略去默认类型声明, 写法如下: Example Source Code [https://www.doczj.com/doc/6c10629068.html,]

AntDesignPro开发手册精编版

AntDesignPro开发手册 修订历史记录

目录

1.前言

1.1目的 让不熟悉Ant Design Pro 的开发人员快速掌握开发方式 1.2概述 Ant Design Pro是一个前端设计解决方案，由蚂蚁金服体验技术部出品/维护。 核心技术组成： ?ES2015+ JavaScript语言的新标准 ?React 用于构建用户界面的JAVASCRIPT 库 ?dva 是基于(redux（状态管理）+ react-router（路由库）+ redux-saga（异 步中间件）等)的一层轻量封装 ?g2 一套基于可视化编码的图形语法 ?antd React组件 2.开发环境 2.1 Node.js 安装配置 Node.js安装包及源码下载地址为：https://https://www.doczj.com/doc/6c10629068.html,/en/download/ 2.2安装方式 2.2.1直接clone git 仓库

git clone --depth=1 https://https://www.doczj.com/doc/6c10629068.html,/ant-design/ant-design-pro.git my-project cd my-project 2.2.2使用集成化的命令行工具ant-design-pro-cli。 npm install ant-design-pro-cli -g #安装脚手架 mkdir my-project cd my-project pro new # 创建一个新项目 2.3 目录结构 ├──mock # 本地模拟数据 ├──public # 公共资源 │└──favicon.ico # 网站图标 ├──src │├──assets # 本地静态资源 │├──common # 应用公用配置，如导航信息 │├──components # 业务通用组件 │├──e2e # 集成测试用例 │├──layouts # 通用布局 │├──models # 数据交互 │├──routes # 业务页面入口和常用模板 │├──services # 后台接口服务 │├──utils # 工具库 │├──g2.js # 可视化图形配置 │├──theme.js # 主题配置 │├──index.ejs # HTML 入口模板 │├──index.js # 应用入口 │├──index.less # 全局样式 │└──router.js # 路由入口 ├──tests # 测试工具 ├──README.md # 项目说明 └──package.json # 项目配置文件 2.4 项目初始化

Web前端开发试题

耐心填一填! 1. 为div设置类a与b,应编写HTML代码_______________ 。 2. 设置CSS属性clear的值为 ______________ 可清除左右两边浮动。 3. _________ 签必须直接嵌套于ul、ol中。 4. CSS属性___________ 为元素设置外补丁。 5. 设置CSS属性float的值为_______________ 可取消元素的浮动。 6. 文字居中的CSS代码是_____________ 二、精心选一选！ 1. 下列哪个样式定义后，内联（非块状）元素可以定义宽度和高度（） A. display:inline B. display:none C. display:block D. display:inheric 2. 选出你认为最合理的定义标题的方法（） A. 文章标题 B. 文章标题 C.

文章标题

D. 文章标题 3. br标签在XHTML中语义为（） A.换行 B.强调 C.段落 D.标题 4. 不换行必须设置（） A.word-break B.l etter-spaci ng C.white-space D.word-spa cing 5. 在使用table表现数据时，有时候表现出来的会比自己实际设置的宽度要 宽，为此需要设置下面哪些属性值（） A. cellpadding= ” 0" B. padding:0 C. margin:。 D. cellspacing= ” 0" 三、判断对或错！ 1. CSS属性font-style 用于设置字体的粗细。（） 2. CSS属性overflow 用于设置元素超过宽度时是否隐藏或显示滚动条。 （） 3. 在不涉及样式情况下，页面元素的优先显示与结构摆放顺序无关。（） 4. 在不涉及样式情况下，页面元素的优先显示与标签选用无关。（） 5. display:i nli ne 兼容所有的浏览器。（） 6. input属于窗体元素，层级显示比flash、其它元素都高。（）

前台编码规范(HTML, JS, CSS)

密级：内部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标签 ?所有标签都应该正确关闭，例如“

…
”，无子元素及内容的标签，可根据W3C规范简化为自关闭标签，例如“”，但有部分自关闭标签兼容性较 差，在无法确认的情况下，都应该使用双标签关闭。例如标签在IE浏览器中可 能无法加载背景图片。 ?为确保兼容性及用户体验一致性，应尽量避免使用以下过时标签：，
，，，，。此外，不要将标签用于页面布局。 ?应尽量避免使用自定义标签名，以增强可读性和可维护性。 ?完整的独立*tml页面，应该内含
标签，并在
中登记keywords, description等信息，以便于搜索引擎收录。 2.3排版 ?HTML标记内部，不允许出现空行及无意义的空格。 ?应正确使用缩进来呈现嵌套关系，子元素应比父级元素缩进一个制表位。但仅有内容无子标签的元素，可在同一行书写，例如“”。 ?如标签属性过多过长，可适当在标签内部换行，但同一页面，同类标签应采用大致相同的换行策略，切忌五花八门。 2.4CSHTML ?向控件赋值应尽量直接使用标准的Model，ViewData或ViewBag，如非必要，不要使用@{}嵌入块，尤其是不要在嵌入块中进行无意义的重复引用，例如“@{var test=@ViewBag.Test;}”。 ?@Html生成器存在多个兼容性问题，应谨慎使用，简单的控件应尽可能使用原生html 标签。例如@Html.DropDownList在绑定已有选中值的数据源时，会丢失已选中项。 3JS 3.1组织 ?应尽可能将JS代码写入独立的JS文件中，而不要直接嵌入页面，以增强缓存利用率及可维护性。 ?相同或类似算法应尽可能统一到同一个方法中，以提高可维护性。尤其是不允许在Creat和Edit页面之间直接Copy相关JS代码。 ?在页面中引用JS文件时，应将引用标签写在标签之后。

web前端开发岗位职责

web前端开发岗位职责 1、前端开发工程师岗位职责 1、根据工作安排高效、高质地完成代码编写，确保符合规范的前端代码规范； 2、负责公司现有项目和新项目的前端修改调试和开发工作； 3、与设计团队紧密配合，能够实现实现设计师的设计想法； 4、与后端开发团队紧密配合，确保代码有效对接，优化网站前端性能； 5、页面通过标准校验，兼容各主流浏览器。 2、WEB前端开发工程师的岗位职责 岗位职责： 1、协助系统架构设计师进行系统架构设计工作； 2、承担WEB前端核心模块的设计、实现工作； 3、承担主要开发工作，对代码质量及进度负责； 4、参与进行关键技术验证以及技术选型工作； 5、和产品经理沟通并确定产品开发需求。 3、web前端开发的岗位职责 在以前可能大部分的人都没有听过什么web前端，最多的就是网页设计或者语言开发。 现在几乎所有的网络公司都有web前端的职位，甚至没有web前端都不好意思说自己是网络技术公司。那么现在学习web前端火不火呢？Web前端在公司主要是做什么呢？先说说前端技术和后端技术的区别：用互联网来做比喻,凡是通过浏览器到用户端计算机的统称为前端技术.相反存贮于服务器端的统称为后端技术。前端技术包括JavaScript、ActionScript、CSS、xHTML等“传统”技术与

Adobe AIR、Google Gears,以及概念性较强的交互式设计,艺术性较强的视觉设计等等. 前端开发工程师（或者说“网页制作”、“网页制作工程师”、“前端制作工程师”、“网站重构工程师”），这样的一个职位的主要职责是与交互设计师、视觉设计师协作，根据设计图用HTML和CSS完成页面制作。同时，在此基础之上，对完成的页面进行维护和对网站前端性能做相应的优化。另外，一名合格的前端开发工程师，应该具有一定的审美能力和基础的美工操作能力，能很好的与交互及视觉协作。 以上可以看出，要成为一名合格的前端开发人员，需要掌握的技术是非常多的，web前端的岗位也是非常具有挑战性的，因此想要加入web前端的人员，选择专业的学习机构是很必要的，笔者知道的北京八维教育有web前端课程。 4、web开发岗位职责 1.负责网站前后台的修改和升级，根据网站业务需要开发，制作和程序修改。 2.参与制定网站研发方案以及，升级方案。 3.参与网站研发，按照要求按时按质按量的完成网站编程开发技术工作。 4.负责网站上线前的测试。 5.负责对网站软硬件设施进行安全和稳定性巡检；并负责统计和监视系统日志。 6.协助公司各部门，满足和协调公司各相关部门提出的网站技术需求。 7.负责网站日常运行的技术维护工作，对出现的问题积极有效的进行处理。

Html5+css3Web前端开发规范标准[详]

Web前端开发规 文件规 为输出高质量的Web页面，提高团队协作效率，便于后台人员添加功能及前端后期优化与维护，如有错误及时提出更改。 1、html，css，js，images,fonts等文件目录组织如下如示： ├── xxx.html ├── css/ │ ├── index.css │ ├── header.css │ ├── footer.css │ └── 2016/ │ │ ├── content.css │ │ └── nav.css ├── js/ │ ├── xxx.js │ ├── xxx_min-tab.js │ └── 2016/ └── images/ │ ├── index_head.jpg │ ├── index_logo.gif │ └── 2016 │ │ ├── xxx.jpg │ │ └── xxx.png └── fonts/ └── xxx.ttf 文件命名原则调整为所有字母小写，单词之间使用破折号（-）相连，压缩后的文件在原文件名（除扩展名）后添加.min。参考bootstrap文件命名：bootstrap-theme.css, bootstrap-theme.min.css。 常用目录名： data(数据库) images(图片) install (安装) templets (模版) include (包含) admin (后台) rss (定阅) media (媒体) config (配置) Script (脚本) Language (语言) style (样式); 引入 CSS 和 JavaScript 文件

class 用于标识高度可复用组件，因此应该排在首位。id 用于标识具体组件，应当谨慎使用（例如，页面的书签），因此排在第二位。 Example link ... 编写 HTML 代码时，尽量避免多余的父元素。很多时候，这需要迭代和重构来实现。 参考如下： 其他要求 ●css文件外链至之间，js文件置于之前。 ●语义化HTML，如标题根据重要性用h*(同一页面只能有一个h1)，段落标记用p，列表 用ul，联元素中避免嵌套块级元素。 ●书写地址时，建议在URL地址后面加上"/"，例如：href="https://www.doczj.com/doc/6c10629068.html,/"。 ●在页面中不能使用style属性，即style="…"；所有样式必须写在css文件中。 ●必须为含有描述性表单元素(input，textarea)添加label，如： : 须写成：： ●能以背景形式呈现的图片，尽量写入css样式中。 ●给重要的元素和截断的元素加上title。 ●建议给区块代码及重要功能（比如循环）加上注释，方便后台添加功能。 ●不是标签一部分的特殊符号都用编码表示，出现在容中的特殊符号都需要用编码形式表 现出来，如：<：<，>：>，&）：&，"："，尽量使用 代替空格。●图片标签必须要有alt属性，如只起修饰作用而没有任何意义的图片可设置alt属性值 为空。如：。

前端开发规范文档

前端开发规范文档 规范目的 为提高团队协作效率，便于后端开发人员添加功能及前端后期优化维护，输出高质量的代码，特制定该文档。本规范文档一经确认, 前端开发人员必须按本文档规范进行前端开发。本文档如有不对或者不合适的地方请及时提出。经讨论决定后方可更改。 基本准则 符合web标准，语义化html，结构表现行为分离，兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。 一、html 文件命名及编写规范 1、命名规则 采用小写英文字母|| _的组合命名，菜单名_功能名称，后缀.html。如：manage_list.html（管理列表）、manage_add.html（新增）、manage_edit.html（修改）、manage_detail.html（详情）。同时将页面放在其对应的模块划分目录中。 2、编写规范： (1)文档类型声明及编码统一为html5声明类型“”; (2)编码统一为, 书写时利用IDE实现层次分明的缩进; (3)区域块、功能组件以及需要标注的地方，插入注释。 (4)在布局文件结构时，应遵循语义化标签（该用p不要用div、该用ul、li不要用p， h标签应根据标题层级合理利用）、代码结构简单、清晰明了，少用标签、少套结构（一段结构布局中 1个标签能解决的不要用2个，套2层结构能解决的不要套3层）的基本原则。

代码标签、结构嵌套示例： 目标效果图 代码结构嵌套

  • 罗田县九资河徐冲药材

    茯苓

    小丁

    32元/公斤

代码分析：根据目标效果图，实现的代码部分别使用了 ul/li /h4/ img /div /h3/ p 这些标 签。首先这是一个产品列表，所以用了ul li 进行包裹；其次，这块分别有两个重要的内容展示，一个是产品名称，一个是企名称，根据权重，代码层分别采用了h3、h4标签；其它的文字展示信息采用了p 标签；图片采用标签img 引入。整个实现，代码结构清晰、标签使用合理，符合语义化、遵循SEO 搜索等原则。 二、CSS 文件命名及编写规范 1、命名规则 用小写英文字母命名（可跟据CSS 作用域以及、区域模块、公用组件、等等分别命名），后缀.css 。如：common.css （公用）、 reset.css （重置）、base.css （页面主体）、form.css （表单）、popup.css （弹层）等等。 2、编写规范： (1)除重置样式使用元素选择器（html\body\div\p\ul\li ……）外，其它原则上使用类选择器（.nav\.header ……）编写样式，如无特别需要，应避免使用ID 选择器（#btn\#foot ……）； (2)编写格式：为提高样式代码的可读性、方便开发人员查找、维护，因此采用单行编写格式，一行编写一个属性和属性值。如果一个类选择器属性只有2到3个，考虑到节省空间问题，可不换行在同行编写；

前端代码规范

福宝童趣 61区项目前端代码规范 代码规范 六一区项目前端组 2016

文档控制 更改记录 日期作者版本更改参考 2016-8-15 1.0 审阅 姓名职位 分发 拷贝号姓名地点 1 2 3 4

目录 代码规范 前端编码规范（1）——一般规范 这是一份旨在增强团队的开发协作，提高代码质量和打造开发基石的编码风格规范，其中包含了HTML, JavaScript 和CSS/SCSS 这几个部分。我们知道，当一个团队开始指定并实行编码规范的话，错误就会变得更加显而易见。如果一段特定的代码不符合规范的话，它有可能只是代码风格错误，而也有可能会是bug。早期指定规范就使得代码审核得以更好的开展，并且可以更精确的地定位到错误。只要开发者们能够保证源代码源文件都严格遵循规范，那接下去所使用的混淆、压缩和编译工具则可投其所好不尽相同。 文件命名规范 在web 项目中，所有的文件名应该都遵循同一命名约定。以可读性而言，减号（-）是用来分隔文件名的不二之选。同时它也是常见的URL 分隔符（i.e. //https://www.doczj.com/doc/6c10629068.html,/blog/my-blog-entry or //https://www.doczj.com/doc/6c10629068.html,/images/big-black-background.jpg），所以理所当然的，减号应该也是用来分隔资源名称的好选择。 请确保文件命名总是以字母开头而不是数字。而以特殊字符开头命名的文件，一般都有特殊的含义与用处（比如compass[1] 中的下划线就是用来标记跳过直接编译的文件用的）。 资源的字母名称必须全为小写，这是因为在某些对大小写字母敏感的操作系统中，当文件通过工具压缩混淆后，或者人为修改过后，大小写不同而导致引用文件不同的错误，很难被发现。 还有一些情况下，需要对文件增加前后缀或特定的扩展名（比如.min.js, .min.css），抑或一串前缀（比如3fa89b.main.min.css）。这种情况下，建议使用点分隔符来区分这些在文件名中带有清晰意义的元数据。 不推荐 推荐 推荐

文本预览
相关文档 最新文档