软件开发命名规则-阿里云开发者社区

开发者社区> zting科技> 正文

软件开发命名规则

简介:
+关注继续查看
 1.1 目的
  为了保证企业编写出的程序都符合相同的规范,保证一致性、统一性而建立的数据库命名规范。
  编码规范对于程序员而言尤为重要,有以下几个原因:
  1. 一个项目的生命周期中,80%的花费在于维护;
  2. 几乎没有任何一个项目,在其整个生命周期中,均由最初的开发人员来维护;
  3. 命名规范可以改善项目的可读性,可以让程序员尽快而彻底地理解新的代码;
  4. 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,比如你已构建的其它任何产品。
  为了执行规范,每个软件开发人员必须一致遵守编码规范。
  1.2 范围
  适合于本项目中编写的命名规则。
  1.3 命名原则
  1. 使名称足够长以便有一定的意义,并且足够短以避免冗长;
  2. 唯一名称在编程上仅用于将各项区分开;
  3. 表现力强的名称是为了帮助人们阅读。
  因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。
  1.4 SQL命名规范
  ·1.4.1 表(Table)命名规范
  1. 使用表关键字符+完整的功能英文名称;
  2. 不建议使用“_”来连接两个自然名称。
  3. 在多个功能英文名称组合时首写字母应为大写;
  例:
  建议:
  UserInfo        基础信息模块中的用户信息
  Shopping     购物信息表单
  不建议:
  tbUserInfo或TB_Userinfo或TBUserInfo
  ·1.4.2 字段(Column)命名规范
  1. 使用 Pascal 大小写来命名字段;
  2. 对于公认的缩写使用全大写来命名;
  3. 不建议使用“_”来连接两个自然名称。
  例:
  建议:
  UserID          用户ID
  UserName        用户名称
  不建议:
  UserId或Userid
  User_Name
  ·1.4.3 存储过程(Procedure)命名规范
  1. 使用表关键字符sp+完整的功能英文名称+By+操作关键字;
  2. 关键字符sp与功能名称通过“_”来连接;
  3. 对于存储过程的参数,建议与表中字段名一致。
  4. 查询关键字为sel,插入关键字为ins,修改关键字为up,删除关键字为del;
  例:
  sp_selUserInfoByID   通过ID查询单条用户信息
  sp_upUserInfoByName     通过用户姓名修改用户详细信息
  sp_insUserInfo      插入单个用户信息
  ·1.4.4 触发器(Trigger)命名规范
  1. 使用表关键字符tr+完整的功能英文名称+By+操作关键字;
  2. 同存存储过程要求
  ·1.4.5 视图(View)命名规范
  1. 使用表关键字符vw+完整的功能英文名称+By+操作关键字;
  2. 同表要求
  ·1.4.6 函数(Function)命名规范
  1. 使用表关键字符ft+完整的功能英文名称;
  2. 同表要求。
  1.5文件规范1.5.1文件名命名
  1.    名字应该能够标识事物的特性;
  2.    名字尽量不使用缩写,除非它是众所周知的;
  3.    名字可以有两个或三个单词组成,但通常不应多于三个。在名字中,所有单词第一个字母大写,缩写都要大写。不建议使用拼音首字母来组成文件名;
  4.    使用名词或名词短语+动词命名文件;例如:UserList.aspx,UserUpdate.aspx
  5.    少用缩写;
  6.    不要使用下划线字符 (_)。例如:User_Query.aspx
  1.5.2文件格式
  文件应该按照以下格式顺序来实现:
  1.         开头注释
  2.         文件名
  3.         创建人
  4.         日期
  5.         描述
  6.         版本
  例子:
  //******************************************************************//
  //
  //** 文件名:   RandomCreator.cs
  //
  //** 创建人:   张三
  //
  //** 日 期:   2007/11/29
  //
  //** 描 述:   主要完成随机数字的生成
  //**
  //
  //** 版 本:   砂子塘社区网 V2.0版
  //
  //******************************************************************//
  using System;
  using System.Collections.Generic;
  using System.Text;
  namespace COMM
  {
  class RandomCreator
  {
  }
  }
  1.5 C#命名规范1.5.1注释(Comment)规范
  注释规范包括:模块(类)注释规范、类的属性、方法注释规范、代码间注释。
  1.5.2类(Class)命名规范
  1.    使用 Pascal 大小写;
  2.    用名词或名词短语命名类;
  3.    使用全称避免缩写,除非缩写已是一种公认的约定,如URL、HTML;
  4.    不要使用类型前缀;
  5.    不要使用下划线字符 (_);
  6.    派生类名称的第二个部分应当是基类的名称;
  例如:
  ApplicationException 对于从名为 Exception 的类派生的类是适当的名称,原因ApplicationException 是一种Exception。
  7.    请在应用该规则时进行合理的判断。
  例如:
  Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件,但是将 Control 作为类名称的一部分将使名称不必要地加长。
  1.5.3接口(Interface)命名规范
  接口的命名规范同类命名,只是通常在名称前加前缀+“I”。
  例子:
  public interface IManager
  1.5.4参数(Param)命名规范
  1.    使用描述性参数名称。参数名称应当具有足够的描述性,以便参数的名称及其类型可用于在大多数情况下确定它的含义;
  2.    对参数名称使用 Camel 大小写;
  例子:
  public ManagerInfo[] GetResultManager(ArrayList alParam,ArrayList alValue)
  {
  return dc.DriveManager().GetResultManager(alParam,alValue);
  }
  1.5.5方法(Method)命名规范
  1.  使用描述性名称。名称应当具有足够的描述性,以便名称可用于在大多数情况下确定它的含义;
  2.  使用动词或动词短语命名方法;
  3.  使用 Pascal 大小写。
  例子:
  public void AddUser(User userInfo)
  1.5.6属性(Property)命名规范
  1.         使用名词或名词短语命名属性;
  2.         使用 Pascal 大小写。
  例子:
  public Color BorderColor
  {
  get {}
  set {}
  }

  来自:龙运在线(www.longyun123.com)



本文转自左正博客园博客,原文链接:http://www.cnblogs.com/soundcode/archive/2011/04/06/2007132.html,如需转载请自行联系原作者

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
如何自己开发软件测试工具
一说到自动化测试工具,大家很多人都会想到的是QTP、LR或者selenium之类的工具,要大家一开始设计一个这样的工具,其实确实很有难度,因为其包含的功能细节太过庞大。当年的我,开始设计开发工具的过程中,走了很多弯路,例如:做工具的界面技术的历程,刚开始用tcl/tk脚本语言,用tcl写底层框架,用tk写图形界面,后来发现tk虽然构造图形方便,但可拓展性实在太差。
1285 0
未来软件开发的主流方向:规则引擎 (Rule Engine)
规则引擎 (Rule Engine)介绍     规则引擎起源于基于规则的专家系统,而基于规则的专家系统又是专家系统的其中一个分支。专家系统属于人工智能的范畴,它模仿人类的推理方式,使用试探性的方法进行推理,并使用人类能理解的术语解释和证明它的推理结论。
930 0
软件版本号规定原则
1. 软件版本阶段说明 * Alpha版: 此版本表示该软件在此阶段主要是以实现软件功能为主,通常只在软件开发者内部交流,一般而言,该版本软件的Bug较多,需要继续修改。 * Beta版: 该版本相对于α版已有了很大的改进,消除了严重的错误,但还是存在着一些缺陷,需要经过多次测试来进一步消除,此版本主要的修改对像是软件的UI。
859 0
Docker有关GUI软件的界面显示设计
欢迎关注大数据和人工智能技术文章发布的微信公众号:清研学堂,在这里你可以学到夜白(作者笔名)精心整理的笔记,让我们每天进步一点点,让优秀成为一种习惯! 有幸得到大神的邮件回复,今天突然发觉,大神应该是在自己的mac上通过ssh访问了一台OS为Ubuntu的的机器或者电脑,其中Ubuntu安装了Docker,Docker运行某个软件或者程序,然后将可视化的界面返回了mac上。
1359 0
高级JAVA开发必备技能:时区的规则发生变化时,如何同步JDK的时区规则(实战方案,建议收藏)
高级JAVA开发必备技能:时区的规则发生变化时,如何同步JDK的时区规则(实战方案,建议收藏)
18 0
+关注
3550
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载