- 浏览: 17281 次
最新评论
ASP.net/C#编码规范
2010年06月03日
以下对本节使用的名词进行说明。 Pascal 所有单词第一个字母大写,其他字母小写。
例如:public void GetUserNameByGuid() Camel 除了第一个单词,所有单词第一个字母大写,其他字母小写。
例如:string userName Hungarian 对象类型(小写)+功能名称(大写,可以无此段)+操作对象(大写)。
例如: 命名规范的具体要求详见表。 项 编码形式 相关例子 注释 文件 Pascal DatabaseConnector 使用名词来描述类 类 Pascal DatabaseConnector 类的名称应该与定义它们的文件的名称匹配 接口 Pascal IDatabaseConnector 接口名称以一个字母I开头 方法 Pascal CalculateBalance 使用动词来描述方法 私有和受保护的实例字段 camel private float accountBalance 公共实例字段 Pascal CustomerName 私有和受保护的类字段 camel protected static int numberOfAccounts 公共类字段 Pascal public static bool HasGoodCredit static final 全部大写 public static final decimal MINNUMBALANCE = 100 局部变量 camel string accountNumber = FindAccountByCustomerName(customerName) 循环计数 全部小写 int i =0; while(i 对象类型名缩写见控件匈牙利命名缩写表 命名空间 Pascal namespace DataLayer 单元测试方法 Pascal TestFindAllCustomers 单元测试名称以单词Test开头。 解决方案 Pascal NorthWindTrader 项目 Pascal DataLayer 控件匈牙利命名缩写表。 标准控件 Button btn CheckBox chk CheckedListBox ckl ComboBox cmb DateTimePicker dtp Label lbl LinkLabel llb ListBox lst ListView lvw MaskedTextBox mtx MonthCalendar cdr NotifyIcon icn NumeircUpDown nud PictureBox pic ProgressBar prg RadioButton rdo RichTextBox rtx TextBox txt ToolTip tip TreeView tvw WebBrowser wbs 容器控件 FlowLayoutPanel flp GroupBox grp Panel pnl SplitContainer spl TabControl tab TableLayoutPanel tlp 菜单和工具栏 ContextMenuStrip cms MenuStrip mns StatusStrip ssr ToolStrip tsr ToolStripContainer tsc 数据 DataSet dts DataGridView dgv BindingSource bds BindingNavigator bdn ReportViewer rpv Repeater rpt 对话框 ColorDialog cld FolderBrowserDialog fbd FontDialog fnd OpenFileDialog ofd SaveFileDialog sfd 组件 BackgroundWorker bgw DirectoryEntry dre DirectorySearcher drs ErrorProvider err EventLog evl FileSystemWatcher fsw HelpProvider hlp ImageList img MessageQueue msq PerformanceCounter pfc Process prc SerialPort spt ServiceController scl Timer tmr 印刷 PageSetupDialog psd PrintDialog prd PrintDocument pdc PrintPreviewControl prv PrintPreviewDialog ppd 水晶报表 CrystalReportViewer crv ReportDocument rpd 其他 DomainUpDown dud HScrollBar hsc PropertyGrid prg Splitter spl TrackBar trb VScrollBar vsc 1、函数、属性、类等注释
请使用///三斜线注释,这种注释是基于XML的,不仅能导出XML制作帮助文档,而且在各个函数、属性、类等的使用中,编辑环境会自动带出注释,方便你的开发。以protected,protected Internal,public声明的定义注释请都以这样命名方法。 类型 相关例子 说明 文档注释 /// /// This class represents a bank account /// 用于文档类和方法 行末注释 int myCount = 0; // Keep track of how many times ... 用于描述某些含义不太清晰的事物的目的 单行注释 // Here is where we gather account data 用于描述后续事物或者代码块的目的 多行注释 /* Here is where we gather account data */ 用于在代码块处进行注释,或者用于描述后续多行代码的目的 2、逻辑点注释
在我们认为逻辑性较强的地方加入注释,说明这段程序的逻辑是怎样的,以方便我们自己后来的理解以及其他人的理解,并且这样还可以在一定程度上排除 BUG。在注释中写明我们的逻辑思想,对照程序,判断程序是否符合我们的初衷,如果不是,则我们应该仔细思考要修改的是注释还是程序了… 1、注意运算符的优先级,我们应该尽量使用括号明确表达式的操作顺序,避免使用默认优先级,给我们以及维护人带来困扰。
2、避免使用不易理解的数字,用有意义的标识来替代(枚举和常量),例如:
if(productType == 0)
…
else if (productType == 1)
…
以上为不合格的做法,以下为推荐使用的方法:
if(productType == ProductType.CD )
…
else if (productType == ProductType.DVD )
… 空行与空格:尽管编译器可以忽略空行与空格,但是空行与空格可以将不同逻辑的代码单元分离,从而提高代码的可读性。
在下述几种情况下应该使用一个空行: l 方法之间
l 声明和语句之间
l 代码的逻辑段之间
l 单行或者多行注释之前 在下述几种情况下应该使用一个空格: l 带圆括号的关键字之后
l 参数列表的逗号之后
l 数据操作符的前后
l 在for语句中,用于将语句的3个逻辑段分开 以上格式可以在Visual Studio中使用ctrl+k,ctrl+d自动排版。 每个解决方案都应该拥有下述项目: l 业务项目(business project)仅存放业务项目。
l 数据项目(data project)处理数据库和其他用于检索或者更新数据目的的遗留系统的访问。
l 表示项目(presentiation project)处理使用系统的终端用户所需的所有视图。
l 测试项目(test project)存放应用程序所有的单元测试。
发表评论
-
Windows Phone开发(一)-- 开发环境和结构
2012-01-20 01:01 938Windows Phone开发(一)-- 开 ... -
windows mobile activex and atl create (from csdn)
2012-01-20 01:01 785windows mobile activex and atl ... -
Android SDK的初步研究
2012-01-20 01:01 688Android SDK的初步研究 2010年09月27日 ... -
Windows下离线安装Android SDK的简单方法
2012-01-20 01:01 1212Windows下离线安装Android SDK的简单方法 2 ... -
“嗲妹妹”与”假小子“
2012-01-19 08:50 583“嗲妹妹”与”假小子 ... -
全国各地的美女特点一览
2012-01-19 08:50 1091全国各地的美女特点一览 2011年05月07日 ... -
全国各地的美女特点一览
2012-01-19 08:50 845全国各地的美女特点一 ... -
上海女人之前世今生
2012-01-19 08:50 649上海女人之前世今生 20 ... -
西湖教育给予我的思考
2012-01-19 08:50 661西湖教育给予我的思考 ... -
Windows系统的Regsvr32
2012-01-17 01:18 666Windows系统的Regsvr32 2011 ... -
as3面试题
2012-01-17 01:18 700as3面试题 2011年09月13日 ... -
电脑高手应用技巧荟萃(电脑知识二十六)
2012-01-17 01:18 482电脑高手应用技巧荟萃(电脑知识二十六) 2010年12月07 ... -
regsvr32用法集合
2012-01-17 01:17 808regsvr32用法集合 2011年12月02日 R&a ... -
web-rpg游戏设计简要分析(转)
2012-01-15 20:01 608web-rpg游戏设计简要分析 ... -
as学习使用!!!
2012-01-15 20:00 828as学习使用!!! 2010年05月 ... -
Flash&Flex大全
2012-01-15 20:00 712Flash&Flex大全 2011年02月24日 ... -
2011-12-12
2012-01-15 20:00 4702011-12-12 2011年12月12日 乱码体: -
乡土菜
2012-01-15 20:00 504乡土菜 2011年12月18日 涓 -
Qt初印象
2012-01-11 12:11 554Qt初印象 2011年06月01日 断断续续已经读 ... -
servelt中GET乱码
2012-01-11 12:11 595servelt中GET乱码 2011年06月01日 sa ...
相关推荐
标准常用的 Asp.net-C#编码规范.docx
asp.net C# 编码规范 asp.net C# 编码规范 asp.net C# 编码规范
在我们进行项目开发过程,必须注意的编码规范准则。
C# ASP.NET 编码命名规范.doc C# ASP.NET 编码命名规范.doc
C#编码规范文档 C#编码规范文档 C#编码规范文档 C#编码规范文档 C#编码规范文档
零度C#.NET编码命名规范.pdf,经典命名规范
C#开发编码规范,适合c#初学者使用,asp.net mvc
ASP.NET编码规范 2 第一章 编码规范概述 2 第二章 静态文件编码规范 2 1. HTML标记语言编码规范 2 1.1 标记的换行规范: 2 1.2 标记的关闭规范 3 1.3 标记的属性赋值规范 3 1.4 标记的缩进规范 3 2. 客户端...
C#编码规范 面试笔试必看 京华志&精华志出品 希望大家互相学习,互相进步 支持CSDN 支持微软 主要包括C# ASP.NET SQLDBA 源码 毕业设计 开题报告 答辩PPT等
收录了很多种编码规范的一个汇总,希望可以对大家的编码规范方面有一定的帮助
代码编写规范说明书(c#.net与asp.net) 1 目的 一.为了统一公司软件开发设计过程的编程规范 二.使网站开发人员能很方便的理解每个目录,变量,控件,类,方法的意义 三.为了保证编写出的程序都符合相同的规范,保证...
内容提要 <br> 本书系统地介绍了ASP.NET程序设计开发,全书案例程序使用C#编写,并遵守C#的编码规范。所有案例程序均来自课堂教学和工程实践,注重知识的兼容性和规范性。 依照ASP.NET编程体系,本书...
Oracle编程的编码规范及命名规则 Oracle数据库字典介绍 0RACLE的字段类型 事务 CMT DEMO(容器管理事务演示) 事务隔离性的一些基础知识 在组件之间实现事务和异步提交事务(NET2.0) 其它 在.NET访问MySql数据库时的...
Net编码规范,所有的程序代码(包括ASP.NET 的页面脚本),应全部采用C#编写。不推荐使用VB.NET。以下编码规范适用于 C#开发。以下命名规则如不特别说明一律采用Pascal 命名方法,即首字母及每个单词首字大写大写。
一.为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。...编码规范和约定必须能明显改善代码可读性,并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作
C#编码规范 PDF 文档。规范的C#编码方式,帮助你养成良好的变成风格,特别对于刚入门的新手是一本不可多得的秘笈!!
ASP.NET编程技术与交互式网页设计 asp.net亲密接触_带源码 C#学习 01_类.htm.txt 02_构造函数的执行序列.htm.txt 03_抽象类和接口.htm.txt 04_结构类型.htm.txt 05_类成员的定义.htm.txt 06_类成员的其他...
C#编程规范,ASP.NET编程规范,编码规范。
介绍C#.net 2005的开发工具,开发环境及配置方法,编码规范介绍C#.net 2005的开发工具,开发环境及配置方法,编码规范
C#开发编码规范 非常全面 京华志&精华志出品 希望大家互相学习,互相进步 支持CSDN 支持微软 主要包括C# ASP.NET SQLDBA 源码 毕业设计 开题报告 答辩PPT等等好多知识