首页 P8.Console命名规则

P8.Console命名规则

举报
开通vip

P8.Console命名规则目的:1)便于理解程序的逻辑流2)便于两个人的项目协作3)便于项目的统一规范,以便后期维护命名基本原则:1)类名:●说明是"什么"而不是"如何",运用名词或者名词短语●仅可使用数字与字母,且不准数字开头,不准使用任何前缀●每个单词首字母大写●自定义异常类应以Exception结尾●文件名要能反映类的内容,最好是和类同名2)方法成员:●强调做什么,而不是是什么,运用动词或者动宾短语词短语●准确描述该方法的功能●每个单词首字母大写3)方法参数:●首字母小写,其余各单词首字母大写●使用描述性参数名称,参数名称应当具有最够...

P8.Console命名规则
目的:1)便于理解程序的逻辑流2)便于两个人的项目协作3)便于项目的统一 规范 编程规范下载gsp规范下载钢格栅规范下载警徽规范下载建设厅规范下载 ,以便后期维护命名基本原则:1)类名:●说明是"什么"而不是"如何",运用名词或者名词短语●仅可使用数字与字母,且不准数字开头,不准使用任何前缀●每个单词首字母大写●自定义异常类应以Exception结尾●文件名要能反映类的内容,最好是和类同名2)方法成员:●强调做什么,而不是是什么,运用动词或者动宾短语词短语●准确描述该方法的功能●每个单词首字母大写3)方法参数:●首字母小写,其余各单词首字母大写●使用描述性参数名称,参数名称应当具有最够的说明性●禁止加p_前缀4)变量成员:●说明是"什么"而不是"如何",运用名词或者名词短语●统一”_”前缀,如果为布尔值,则”_is”前缀●首字母小写,其余每个单词首字母大写。除非”_is”前缀,则每个单词首字母均大写●类中访问修饰符或功能相同的方法应该放在一起,且公共或实现接口的方法在前5)属性成员:●说明是什么,而不是如何,运用名词或者名词短语●首字母大写,如果是布尔值,则”Is”作为前缀●如果返回值是枚举类型值,则以枚举类型作为属性名●属性和相应字段名称要关联,属性名除大小写区别外应该与关联的成员变量的去除前缀”_”之后的部分一致6)接口:●统一加上前缀:I●其余同类名7)结构体:●同类名8)枚举:●同类名9)委托命名:●强调做什么,而不是是什么,运用动词或者动词短语●准确描述该方法的功能,如CallBack表示回调委托●每个单词首字母大写●作为事件委托时,参数必须是sender与e。其中sender为object类型,e必须是EventArgs类型或者其子类型。(此处意味着自定义事件,必须先自定义事件,其中自定义事件必须继承自EventArgs类)。事件用到的参数类,名称要带EventArgs后缀。public class TestEventArgs : EventArgs{public readonly char KeyToRaiseEvent;public TestEventArgs(char keyToRaiseEvent){KeyToRaiseEvent=keyToRaiseEvent;}}自定义事件的示例●作为事件委托时,必须加上EventHandle作为后缀public delegate void TestEventHandler(object sender, TestEventArgs e);事件委托声明的示例10)事件命名:●将事件委托的后缀Handle去掉即可。其余保持与事件委托的名称一致public event TestEventHandler TestEvent;事件命名示例11)命名长度不宜超过三个单词12)变量名不可以泛写,如不准出现Flag之类的命名,命名必须准确描述是什么,如DocType13)变量名命名需利用面向对象思想减少冗余14)常量命名规范  UPPER,如constMAXTIME;15)临时变量可加tmp前缀以示区别代码书写 格式 pdf格式笔记格式下载页码格式下载公文格式下载简报格式下载 规范1)文件之中不得存在无规则的空行,比如说连续十个空行。函数与函数之间的空行为2行。函数与函数之间统一空格两行。#region以及#endregion与相邻代码块之间空格一行。属性声明之间空1行,成员变量声明之间无需空行。#region代码块之间空格两行2)在函数体内部,在逻辑上独立的两个函数块可适当空行,一般为1行。3)每行长度尽量避免超过屏幕宽度,应不超过80个字符。(自动换行)4)使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。如将 x=a*b/c*d写成x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d)。5)避免过多的循环嵌套和条件嵌套。6)一个函数不要超过200行。一个文件应避免超过2000行。正常方法控制在40行内,类控制在400行内。7)禁止采用多赋值语句,如x=y=z;。代码注释规范●.cs文件的注释所有.cs文件开头都要加上注释,写明文件创建时间、作者、用途概述等//********************************************************//新增日期:2004.7.19//作者:XXX//內容说明: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX//********************************************************.cs文件头注释示例●函数过程注释所有的函数体开头都要加上注释,所以注释使用.NET注释规范//////用途描述//////参数:STRING描述///参数:STRING描述///返回:INT描述publicintUpgradeThread(stringxxx1,stringxxx2){//…return0;}.NET规范MXL描述 模板 个人简介word模板免费下载关于员工迟到处罚通告模板康奈尔office模板下载康奈尔 笔记本 模板 下载软件方案模板免费下载 ●常量变量注释所有的常量变量,无论是全局还是局部使用的,凡是对代码整体起到关键性做用的都需要加上注释。//////当前线程指向的备份文件本地保存路径///publicstringStorePath="";常量变量注释模板●代码修改注释当开发者维护以前的程序代码时,需要在修改处的开始及结尾,加上自己的注释信息。//BEGIN2004-7-19Jayson 修正了XXX问题//略…//END2004-7-19Jayson代码修改注释模板命名空间:根命名空间:P82010.Console用户界面层:P82010.Console.UILayer逻辑层:P82010.Console.Core模型层:P82010.Console.ModuleLayer数据协议层:P82010.Console.DataProtocolLayer通信层:P82010.Console.TransferLayerP8模型层:类名:监控中心:SupervisionCenter监控区域:SupervisionArea监控单元:SupervisionUnit监控对象:SupervisionObject监控模块:SupervisionModule监控点:SupervisionPoint通信处理机:CommunicationProcessor通信端口:CommunicationPort监控设备:SupervisionEquipment
本文档为【P8.Console命名规则】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
该文档来自用户分享,如有侵权行为请发邮件ishare@vip.sina.com联系网站客服,我们会及时删除。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
下载需要: 免费 已有0 人下载
最新资料
资料动态
专题动态
is_654168
暂无简介~
格式:doc
大小:27KB
软件:Word
页数:9
分类:
上传时间:2022-08-05
浏览量:0