c/c++ -->自我编程风格总结

根据最近几年的项目实践及参考别人的代码,将自我养成的编程风格总结如下。

1、命名风格

命名格式如下:

模块名_类型名_名称字符串

模块名:说明此函数或变量等属于哪类模块,用于了解功能划分,一般为名词。

类型名:说明对象为函数还是为数据,数据类型是什么。这样可以明确类型及变量的取值范围,避免数据溢出,一般为小写。

名称字符串:解释此对象的唯一用途,此字符串便是最好的程序注释,用驼峰法表示,在函数中一般为动词。

例如:

函数的命名:

void LED_func_On(void)
{

}

变量的命名:

uint32_t Flash_u32_ReadAddr;

对于指针类型,在类型名前加小写p表示,比如:

uint32_t * Flash_pu32_ReadAddr;

备注:局部变量可以省去模块名。

下面对类型名做一下简单总结:

类型 简写
整型、字符型
u->无符号

i ->有符号

数字->数据范围

如:

xx_u8_xx 为无符号8位数据

xx_i16_xx 为有符号16位数据

浮点型
f->说明为浮点型

数据->数据范围

如:

xx_f32_xx为单精度浮点

xx_f64_xx为双精度浮点

结构体
xx_str_xx

枚举
xx_en_xx

联合
xx_un_xx

布尔
xx_b_xx

函数
xx_func_xx

  

若有所悟,必定尽快更改及更新!

  

时间: 2024-10-08 10:34:45

c/c++ -->自我编程风格总结的相关文章

程序员要遵守的一些优秀编程风格

无论你是业余的还是专业的程序员,正确的编程风格,不但有助于提升软件产品的功能,还可以明显减少软件灾难的产生.今天,我们就来探讨一下有助于我们获取更佳编程风格的一些最好的规则. 代码的可读性至上 代码要能可阅读和可理解,就需要格式化成一致的方式.对函数和变量的命名应有意义,注释的表达应该简洁而准确.并且,准确地记录代码中所有棘手的部分是十分重要的.你必须清楚软件程序为什么能工作以及为什么能在所有可能的情况下顺利工作的原因. 遵循正确的命名约定是必须的 当需要给类.函数和变量命名时,你需要遵循以下指

【Spring】SpringMVC之REST编程风格

REST架构是一个抽象的概念,目前主要是基于HTTP协议实现,其目的是为了提高系统的可伸缩性.降低应用之间的耦合度.便于架构分布式处理程序. 在URL中设置使用如下方式: /{变量名1}/{变量名2} 在代码中向Controller方法注入参数:  (@PathVariable("变量名1") String str1,@PathVariable("变量名2") String str2) 例如: @RequestMapping(value="/book/{b

强调一下编程风格

讲完了Java的基础语法,大家就可以编写简单的程序代码了,这里有必要强调一下编程风格. 代码风格虽然不影响程序的运行,但对程序的可读性却非常重要.自己编写的程序要让别人看懂,首先在排版方面要非常注意. 其实每个人的编程风格.每个软件开发公司的编程风格都不一样.一个人编写的程序代码,就应该能让别人看懂,甚至是过了很长时间,自己也要看的懂,否则这个程序就成了一个死程序. 编程风格是指编程时的格式,让程序看上去就很有层次感.下面通过一些例子,说明编程风格的重要性: public class math{

C++服务器开发之基于对象的编程风格

Thread.h #ifndef _THREAD_H_ #define _THREAD_H_ #include <pthread.h> #include <boost/function.hpp> class Thread { public: typedef boost::function<void ()> ThreadFunc; explicit Thread(const ThreadFunc& func); void Start(); void Join();

编程风格(Coding Style)要求

编程风格(Coding Style)要求2.1.1 文件(1) 每个模块(module)一般应存在于单独的源文件中,通常源文件名与所包含模块名相同.(2) 每个设计文件开头应包含如下注释内容:? 年份及公司名称.? 作者.? 文件名.? 所属项目.? 顶层模块.? 模块名称及其描述.? 修改纪录.2.1.2 大小写(1) 如无特别需要,模块名和信号名一律采用小写字母.(2) 为醒目起见,常数(`define定义)/参数(parameter定义)采用大写字母.2.1.3 标识符(1) 标识符采用传

Javascript编程风格

转自阮一峰 http://www.ruanyifeng.com/blog/2012/04/javascript_programming_style.html 作者: 阮一峰 日期: 2012年4月27日 Douglas Crockford是Javascript权威,Json格式就是他的发明. 去年11月他有一个演讲(Youtube),谈到了好的Javascript编程风格是什么. 我非常推荐这个演讲,它不仅有助于学习Javascript,而且能让你心情舒畅,因为Crockford讲得很幽默,时不

Google Java编程风格指南--命名约定

命名约定5.1 对所有标识符都通用的规则标识符只能使用ASCII字母和数字,因此每个有效的标识符名称都能匹配正则表达式 \w+ .在Google其它编程语言风格中使用的特殊前缀或后缀,如 name_ ,  mName ,  s_name 和 kName ,在Java编程风格中都不再使用.5.2 标识符类型的规则5.2.1 包名包名全部小写,连续的单词只是简单地连接起来,不使用下划线.5.2.2 类名类名都以 UpperCamelCase 风格编写.类名通常是名词或名词短语,接口名称有时可能是形容

转:从《The C Programming Language》中学到的那些编程风格和设计思想

这儿有一篇写的很好的读后感:http://www.cnblogs.com/xkfz007/articles/2566424.html 读书不是目的,关键在于思考. 很早就在水木上看到有人推荐<The C Programming Language>这本书,一直都没看,开学一个月就专心拜读了一下,并认真做了课后习题.读来收获不少,主要有两点:一是加深了自己对一些基础知识的理 解和感悟:二是从中学到了一些不错的编程风格和设计思想,这些东西虽看起来不起眼但细细嚼来还是很值得学习的.下面就从四个方面做一

Java知多少(17)强调一下编程风格

讲完了Java的基础语法,大家就可以编写简单的程序代码了,这里有必要强调一下编程风格. 代码风格虽然不影响程序的运行,但对程序的可读性却非常重要.自己编写的程序要让别人看懂,首先在排版方面要非常注意. 其实每个人的编程风格.每个软件开发公司的编程风格都不一样.一个人编写的程序代码,就应该能让别人看懂,甚至是过了很长时间,自己也要看的懂,否则这个程序就成了一个死程序. 编程风格是指编程时的格式,让程序看上去就很有层次感.下面通过一些例子,说明编程风格的重要性: 1 public class mat