前段开发命名规则Word格式文档下载.docx
《前段开发命名规则Word格式文档下载.docx》由会员分享，可在线阅读，更多相关《前段开发命名规则Word格式文档下载.docx（28页珍藏版）》请在冰点文库上搜索。
guild
服务：
service
注册：
regsiter
状态：
status
投票：
vote
合作伙伴：
partner
XHTML文件中id的命名
（1）页面结构
容器:
container
页头：
content/container
页尾：
（2）导航
主导航：
mainbav
顶导航：
topnav
边导航：
左导航：
leftsidebar
右导航：
rightsidebar
标题:
title
摘要:
summary
（3）功能
登陆：
login
功能区：
shop
标题：
按钮：
btn
当前的:
current
图标:
icon
注释：
note
link
CSS+DIV的命名规则：
登录条:
loginBar
标志:
侧栏:
sideBar
广告:
导航:
子导航:
subNav
菜单:
子菜单:
subMenu
搜索:
滚动:
页面主体:
内容:
标签页:
文章列表:
提示信息:
小技巧:
栏目标题:
友情链接:
friendLink
页脚:
加入:
指南:
服务:
热点:
新闻:
下载:
注册:
状态:
按钮:
投票:
合作伙伴:
版权:
copyRight
1.CSSID的命名
外套:
wrap
主导航:
mainNav
整个页面:
页眉:
商标:
label
mainNav（globalNav）
顶导航:
边导航:
左导航:
leftsideBar
右导航:
rightsideBar
旗志:
标语:
菜单内容1:
menu1Content
菜单容量:
menuContainer
边导航图标:
sidebarIcon
注释:
面包屑:
breadCrumb（即页面所处位置导航提示）
container
登陆:
功能区:
shop（如购物车，收银台）
当前的current
2.样式文件命名
主要的:
master.css
布局版面:
layout.css
专栏:
columns.css
文字:
font.css
打印样式:
print.css
主题:
themes.css
说明：
均为class，需要扩展，则在当前命名内以“_“（下划线）后缀自定名称。
我习惯称列表页为list，新闻列表则为newslist，图片列表为piclist，
内容页为view，
/**/
整体大框架：
#wrapper
大框架内：
#inwrapper
/////////////////////////////////////////////////////////////////////////////////////////////////////////
顶部及banner：
.top
顶部及banner内：
.intop
Logo：
.logo
Banner：
.banner
.menu
导航内：
.inmenu
.Menuul
.Menuulli
.Menuullia
下拉菜单：
.inmenu_xiala
.Inmenu_xialaul
.Inmenu_xialaulli
.Inmenu_xialaullia
///////////////////////////////////////////////////////////////////////////////////////////////////////////
主体内容：
.mainWrapper
主体内容内：
.inmainwrapper
左侧拦：
.sideleft
左侧内：
.insideleft
右侧栏：
.sideright
右侧内：
.insideright
中间：
.sidecenter
中间内：
.insidecenter
/////////////////////////////////////////////////////////////////////////////////////////////////////////////
底部：
.foot
底部内：
.infoot
////////////////////////////////////////////////////////////////////////////////////////////////////////////
/*其他命名*/
.search
搜索内：
.insearch
搜索条：
.searchselect
搜索按钮：
.serachbuttom
输入文本框：
.input
.select
/*表格样式*/
表格整体框架：
.listbox
表格的宽度：
.listbox-table
表格头部文字样式：
.listbox-header
表格正文文字样式：
.listbox-entry
/*通用型*/
通用：
.GM/*这个有点郁闷,英文太差...*/
通用内：
.INGM
通用左浮动：
.GMfl（GMFLOATLEFT）
通用右浮动：
.GMfr（GMFLOATRIGHT）
/*通用图片样式*/
通用图片样式：
.img
/*清除浮动*/
清除所有浮动：
.clear
清除左侧浮动：
.clearleft
清除右侧浮动：
.clearright
/*文字样式*/
文字：
.font
/*新闻列表*/
新闻列表：
.fontnews
/*View页字体总样式*/
VIEW页字体：
.fontview
商 标：
label
标 题：
title
mainbav（globalnav）
topnav
sidebar
leftsidebar
rightsidebar
旗 志：
logo
标 语：
banner
菜单内容1：
menu1content
菜单容量：
menucontainer
submenu
边导航图标：
note
面包屑：
breadcrumb（即页面所处位置导航提示）
容器：
container
content
search
Login
shop（如购物车，收银台）
当前的 current
报头：
masthead
摘要,概要 summary或general
左边的浮动照图片photoleft
右边的浮动图片photoright
标题 title
条目底端 entrybottom
更多 extended或.more
容器背景containerbg
服务 service
服务链接 servicelink
线 line
文本 text
右边 rightside
版权 copyright
新闻 news
书皮 wrapper
介绍 intro-part1
专栏 column
路径 pathways
片断 section
模块 module
上导航 subnav
2.另外在编辑样式表时可用的注释可这样写：
<
--Footer-->
内容区
--EndFooter-->
3.样式文件命名
主要的master.css
布局，版面layout.css
专栏columns.css
文字font.css
打印样式print.css
主题themes.css
4.样式表中的注示
实例一
/*GLOBAL---------------------------*/
/*LINKS---------------------------*/
/*FORMS---------------------------*/
/*IDS---------------------------*/
/*HEADER---------------------------*/
/*COLUMN1---------------------------*/
/*COLUMN2---------------------------*/
/*CLASSES---------------------------*/
实例二
HTML
实例三（网易）
CSS
#UrsLogin
#LogoNav
#Column
#Content1
#bNav
#Copyright
#SearchArea
#ChannelArea
#HotNews
#NewsCenter
.keyword
#MallArea
#city
#aboutus
……………………
常见命名
包含wrapper和container
页头header或缩写为hd
页尾footer或缩写为ft
导航nav
您的位置breadcrumbs
二级导航sub_nav
侧栏sidebar或side-column
模块module
数据库中的命名规则
数据库涉及字符规则
采用26个英文字母（区分大小写）和0－9这十个自然数，加上下划线_组成，共63个字符。
不能出现其他字符（注释除外）。
数据库对象命名规则
数据库对象包括表、视图（查询）、存储过程（参数查询）、函数、约束。
对象名字由前缀和实际名字组成，长度不超过30。
前缀：
使用小写字母。
例如：
表-tb视图-vi存储过程-sp函数-fn
实际名字
实际名字尽量描述实体的内容，由单词或单词组合，每个单词的首字母大写，其他字母小写，不以数字和_开头。
表User_Info视图UserList存储过程UserDelete
因此，合法的对象名字类似如下。
表tbUser_Info、tbMessage_Detail
视图vi_MessageList
存储过程sp_MessageAdd
数据库表命名规则
字段由前缀和实际名字组成。
实际名字中首单词一个系统尽量采取同一单词。
使用小写字母tb，表示表。
tbMember tbMember_Info tbForum_Board tbForum_Thread1
字段命名规则
数字、字符、日期/时间、lob（大对象）、杂项，字段由表的简称、下划线，实际名字加后缀组成。
后缀：
使用小写字母，代表该字段的属性。
例如:
User_Idint User_Namestr User_RegDatedtm
视图命名规则
字段由前缀和实际名字组成，中间用下划线连接。
使用小写字母vi，表示视图。
vi_User vi_UserInfo
存储过程命名规则
使用小写字母sp，表示存储过程。
sp_User
数据库设计文档规则
所有数据库设计要写成文档，文档以模块化形式表达。
大致格式如下：
'
-------------------------------------------
表名：
tbUser_Info
建立人：
UAM_Richard
日期：
2004-12-17
版本：
1.0
描述：
保存用户资料
具体内容：
UserId int，自动增量 用户代码
UserName char（12） 用户名字
......
--------------------------------------------
CSS类及id中的命名规则
Web开发人员可以通过创建CSS类及id名称并使用这些名称来对div以及其他的格式页面元素进行标识。
对开发人员来说，在命名重新定义XHTML标记（tags）的CSSselectors时，必须保证其与预定义的标记准确匹配，但就类以及id选择器名称而言，则仁者见仁，智者见智。
然而随心所欲的为这些类以及id命名则并不是个好的习惯。
1、直观命名
当在设计Web页面以及需要对一个div进行标识的时候，最自然的想法就是使用可以描述元素所在页面位置的词汇来对其命名。
top-panel
horizontal-nav
left-side
center-column
right-col
这些是CSS以及XHTML类和id的有效命名方式。
这些词汇简单并且能够使人顾名思义，因此满足了标识页面元素以及相应的CSS样式的需要。
但问题是这样的名称同页面内容的特定表达方式相关联。
这些命名参考了某种特定页面布局中的页面元素位置，因此在这样的布局之外使用就会显得不合适甚至造成理解混乱。
这些命名没有涉及文档内容的结构。
因此，下面给出了对CSS类以及ID命名更好的方法。
2、结构化命名
这些是CSS以及XHTML类和id的有效命名方式。
有标记的相关信息都是用来描述文档的结构而不是外观。
这样的特点使得我们可以通过简单的改变CSS的方式来对不同外观格式下的内容（content）以及标记（markup）进行重用。
当你理解这种方式时，很容易就可以发现采用页面位置来为类以及id命名的方式在处理如音频（audio）等外观格式上显得非常不合适。
因此，应当根据在文档中的使用目的而非出现位置来对类以及id进行结构化命名。
可以按照如下所示的结构化方式来对类以及id名称命名：
branding
main-nav
main-content
这些名字同直观命名方式一样非常易懂，但他们描述了页面元素的作用而非位置。
这使得代码更加符合使用纯粹的结构化标记（structuralmarkup）的初衷，即开发人员可以在不改变标记的情况下对各种各样媒体下的显示格式进行处理。
即使你不打算在其他的媒体上对Web页面进行格式修改，使用结构化命名方式还可以帮助你在日后的站点升级或重新设计中更为轻松。
例如，结构化命名避免了当一个div同idright-column移动到页面左边后所带来的混乱。
对divsidebar的采用这样的命名方式就显得更加适当，因为无论它出现在页面的哪一边，这个名字仍然对开发人员来说直观易懂。
3、惯例
AndyClarke分析了40份由推崇标准化Web设计理念的开发人员所设计的Web站点的源代码。
尽管类以及id名称很不统一，但是还是发现了一些频繁出现的常用名称。
这里给出了最常用类/id名称的示例列表：
3.基于成员的命名规范
基于成员的命名规范是指按照文件,文件夹的从属关系,通过归类的方法进行命名,这样可以使文件的排列具有较强的逻辑性.
一个图片文件是在鼠标点击之前为"
file_on"
.而在点击后的图片文件命名为"
file_off"
根据这个类别命名.更加的清晰.
4.基于属性的命名规范
装饰性小图片按照"
图片内容说明>
_<
颜色>
图片尺寸>
序号>
.*"
来表现.这个为"
heart_red_401*334_1.jpg"
5.基于序数的命名规范
在网页中一般为了减少图片的下载时间把图片分隔成一小部分,组成一个整体图.这时可以用二维数组的方式命名.
这个图片为"
donghua_11.jpg"
donghua_12.jpg"
donghua_21.jpg"
donghua_22.jpg"
这些组成一幅图片.
6.基于枚举的命名规范
第一个为书的侧面为"
ddd_cemian.jpg"
第二个为书的封皮为"
ddd_fengpi.jpg"
第三个为书的封底为"
ddd_fengdi.jpg"
还有的网站上图片的欣赏也有不同的大小,可根据用户的意愿查看.
"
ddd_cemian_401*334.jpg"
和"
ddd_cemian_1024*768.jpg"
这些供大家建设网站参考.
为避免代码冲突（这样做也会让你的代码更为通用），就要使用命名法则，这是一个很好的编程习惯。
好啦，这里介绍一些常用的法则。
◆命名变量、方法、以及属性
变量、方法和属性的名称的第一个字母应该大写，并且名称应该能表达出它们的用途（或者说是意义）。
变量
.NET命名
匈牙利命名
描述
Cstring
EmployeeName
szName
Nameofanemployee.
Int
AttendanceCounter
nCounter
Acounteroftypelong.
Long
NumberOfBytes
lBytes
Alongtypevariablestoresbytes.
有时我们习惯于在定义中使用下划线"
_"
，例如：
Add_Data（inta,intb）.按照新的命名法则，这不是一个好的编程习惯，虽然它并没有错。
你应该将定义Add_Data改为AddData。
这不是微软的标准，你也不是必须按照这些法则。
但是，在一些地方你会明白下边这些法则的合理性。
就我个人而言，我更喜欢匈牙利命名法。
当然，变量也使用同样的法则。
如果你记得匈牙利命名法的话，一个布尔型的变量定义以"
b"
打头，比如：
BOOLbFlag=TRUE;
新的法则不推荐使用Flag和"
：
boolIsFileFound=true;
你可以浏览一下MSDN，那里边有更多有关新的法则的说明。
◆命名组件以及集合（Assemblies）
为避免代码冲突,按照命名法则给你的库（在.NET中称为assembly）命名是一个良好的编程习惯。
假定你是MindCracker公司的，你在开发一个用于扩充C#database类的库,把它的名字命名为MindCracker.DatabaseAssembly.ADOSet要比MyAssembly.Database.ADOSet好的多。
再假定你的库有一个方法，它是从表中读取数据，并返回一个数据集。
你如果取名为DataSetreturn_data（）的话，改为DataSetReturnData（）好啦.
你还应该在命名中遵循一个统一的单词顺序。
例如，你有俩个表，分别为Employee和Manager，并且你还为它们分别定义了一个向表里边插入一条记录的方法，那么方法名AppendEmployee和AppendManager要比AppendEmployee和ManagerAppend要好。
我更喜欢的二种方法，因为很容易清楚一个块儿结构和嵌套块儿结构。
◆匈牙利命名法（efoxxx附）
匈牙利命名法是一名匈牙利程序员发明的，而且他在微软工作了多年。
此命名法就是通过微软的各种产品和文档传出来的。
多数有经验的程序员，不管他们用的是哪门儿语言，都或多或少在使用它
这种命名法的基本原则是：
变量名＝属性＋类型＋对象描述
即一个变量名是由三部分信息组成，这样，程序员很容易理解变量的类型、用途，而且便于记忆。
下边是一些推荐使用的规则例子，你可以挑选使用，也可以根据个人喜好作些修改再用之。
⑴属性部分：
全局变量：
g_
常量：
c_
类成员变量：
m_
⑵类型部分：
指针：
p
句柄：
h
布尔型：
b
浮点型：
f
无符号：
u
⑶描述部分：
初始化：
Init
临时变量：
Tmp
目的对象：
Dst
源对象：
Src
窗口：
Wnd
将介绍匈牙利命名法，后面的例子里也会尽量遵守它和上面的代码风格。
还是那句话，并不是要求所有的读者都要去遵守，但是希望读者作为一个现代的软件开发人员都去遵守它。
aArray数组
bBOOL（int）布尔（整数）
byUnsignedChar（Byte）无符号字符（字节）
cChar字符（字节）
cbCountofbytes字节数
crColorreferencevalue颜色（参考）值
cxCountofx（Short）x的集合（短整数）
dwDWORD（unsignedlong）双字（无符号长整数）
fFlags（usuallymultiplebitvalues）标志（一般是有多位的数值）
fnFunction函数
g_global全局的
hHandle句柄
iInteger整数
lLong长整数
lpLongpointer长指针
m_Datamemberofaclass一个类的数据成员
nShortint短整数
pP
升级会员 