2.2 C#编程风格
大家在阅读MS代码时会发现,代码编写命名有一定的风格,看起来很自然,尤其是函数名,如同写英文一样,没有缩写,普遍采用动名词结构,并且单词连接用大小写容易分清楚,基于Source Insight编辑器,整体看起来很优雅。这种编程风格就是微软在2001年推出的基于Microsoft.NET平台的C#编程风格,简单而又优雅。
C#是微软总结了2001年以前的软件发展历史,以C、C++为母体,借鉴Delphi、VB简单、易用的理念,Java的跨平台思想,借助现代智能的编辑环境(抛弃了以前因为编辑环境不够智能导致编码约束),全新打造的一款面向自然的程序设计语言。
C#的编程规范很简单,尽可能自然,不破坏原来的思维习惯。当然,我们之所以使用C#的编程规范,很大原因是基于智能编辑环境如Source Insight,现在的MDK-ARM编译器性能也大大提升了。MS中用到的C#规范主要有以下几条:
1)操作函数尽可能用动宾短语,比如SetBit、GetBit、InitUsart等。
2)参数、局部变量的第一个字母小写,后面的单词首字母大写,比如sendData,这种叫Camel命名法,或叫骆驼命名法。
3)除参数和局部变量之外,比如全局变量、宏定义、枚举、结构体、函数等,都采用英文首字母大写方式,这种叫Pascal命名法,或叫帕斯卡命名法,比如MmiFunction。
4)仅仅对于由一个或者两个字母的缩写组成的,用全大写命名法则,如ID、SN,3个及以上的,回归到Pascal命名法,比如Pwm。
MS吸收了C#的几个的编程规范,其他方面的规范,读者根据自己的情况灵活应用。除了一些约定俗成的缩写外,一般不推荐缩写,有些确实很长的名字可以采用缩写,但建议声明一下这个缩写名对应的完整原名。
C#命名规范只有寥寥几点,简单、易掌握,MS仅采纳了四条C#推荐命名规范,清晰明了,这样统一了命名规范,适合中小企业等多人协作开发。此外,按照英文的逻辑描述函数名字,把注释融入代码中,一目了然,都不需要额外的注释。