当前位置:  编程技术>.net/c#/asp.net

C#书写规范

    来源: 互联网  发布时间:2014-10-12

    本文导语:  C#书写规范  一、命名  对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如...

C#书写规范 
一、命名 
对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。 
命名原则是: 
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。 
以下几点是推荐的命名方法。 
1、方法、属性、变量规范 
避免容易被主观解释的难懂的名称,如方面名 AnalyzeThis(),或者属性名 xxK8。这样的名称会导致多义性。 
在面向对象的语言中,在类属性的名称中包含类名是多余的,如 Book.BookTitle。而是应该使用 Book.Title。 
使用动词-名词的方法来命名对给定对象执行特定操作的例程,如 CalculateInvoiceTotal()。 
在允许函数重载的语言中,所有重载都应该执行相似的函数。 
只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。 
在变量名中使用互补对,如 min/max、begin/end 和 open/close。 
鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以简化它们的阅读。另外,为了帮助区分变量和例程,请对例程名称使用 Pascal 大小写处理 (CalculateInvoiceTotal),其中每个单词的第一个字母都是大写的。对于变量名,请使用 camel 大小写处理 (documentFormatType),其中除了第一个单词外每个单词的第一个字母都是大写的。 
布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 fileIsFound。 
在命名状态变量时,避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag,而是使用更具描述性的名称,如 documentFormatType。 (此项只供参考) 
即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i 或 j。 
可能的情况下,尽量不要使用原义数字或原义字符串,如 For i = 1 To 7。而是使用命名常数,如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。 
二、代码书写规范 
    格式化使代码的逻辑结构很明显。花时间确保源代码以一致的逻辑方式进行格式化,这对于您和你的开发小组,以及以后维护源代码的其他开发人员都有很大的帮助。 
以下几点是推荐的格式化方法。 
建立标准的缩进大小(如四个空格),并一致地使用此标准。用规定的缩进对齐代码节。 
在发布源代码的硬拷贝版本时使用特定的字体以及字号(新宋体、小五号)。 
在括号对对齐的位置垂直对齐左括号和右括号,如: 
      for (i = 0; i 

    
 
 

您可能感兴趣的文章:

 
本站(WWW.)旨在分享和传播互联网科技相关的资讯和技术,将尽最大努力为读者提供更好的信息聚合和浏览方式。
本站(WWW.)站内文章除注明原创外,均为转载、整理或搜集自网络。欢迎任何形式的转载,转载请注明出处。












  • 相关文章推荐
  • 各位高手:本人初学JDBC对各个数据连接时的URL的书写还很模糊,有谁可以提供以下各数据库的连接发,由其是URL的书写。
  • 大家来谈谈java语言的书写规则吧。(分数不断增加中)
  • Markdown的书写工具 A Markdown
  • 急!请问大虾,如何书写UNXI下的MakeFile以编译C(调用了某些库)程序?
  • 书写基于Linux内核的键盘记录器(Writing Linux Kernel Keylogger)中的源码如何编译通过???
  • Mozilla建议的CSS书写顺序
  • 我参照书写了几个EJB文件,编译不了,为什么?
  • 在unix中的make的书写格式
  • 关于makefile.am的书写
  • 这个参数该怎么书写?
  • html页面如何指向web-inf/classes下的applet。是否使用codebase之类的说明,该如何书写。
  • dhcpd.conf中range dynamic-bootp后面如何进行分段地址书写?
  • jbuilder书写的时候,光标怪怪的,老是后退两格,怎么办?
  • xx.java继承yy.class,编译xx.java为xx.class时应怎样书写?(谢谢)
  • 请问这样的书写是什么意思?
  • 对 linux C 编程 makefile书写的疑问(二)
  • 关于简单的Makefile文件的书写问题,大家帮我
  • 小心:CSS代码书写顺序不同,导致显示效果不一样
  • 对 linux C 编程 makefile书写的疑问
  • firefox推荐与个人理解的css书写顺序


  • 站内导航:


    特别声明:169IT网站部分信息来自互联网,如果侵犯您的权利,请及时告知,本站将立即删除!

    ©2012-2021,,E-mail:www_#163.com(请将#改为@)

    浙ICP备11055608号-3