EDA365欢迎您登录！
您需要 登录 才可以下载或查看，没有帐号？注册
x
0.1 箴言 技术人员设计程序的首要目的是用于技术人员沟通和交流，其次才是用于机器执行。程序的生命力在于用户使用，程序的成长在于后期的维护及根据用户需求更新和升级功能。 如果你的程序只能由你来维护，当你离开这个程序时，你的程序也和你一起离开了，这将给公司和后来接手的技术人员带来巨大的痛苦和损失。 因此，为了程序可读、易理解、好维护，你的程序需要遵守一定的规范，你的程序需要设计。 “程序必须为阅读它的人而编写，只是顺便用于机器执行。” —— Harold Abelson 和 Gerald Jay Sussman “编写程序应该以人为本，计算机第二。” —— Steve McConnell 0.1 简介 为提高产品代码质量，指导仪表嵌入式软件开发人员编写出简洁、可维护、可靠、可测试、高效、可移植的代码，编写了本规范。 本规范将分为完整版和精简版，完整版将包括更多的样例、规范的解释以及参考材料(what & why)，而精简版将只包含规则部分(what)以便查阅。 在本规范的最后，列出了一些业界比较优秀的编程规范，作为延伸阅读参考材料。 本规范主要包含以下两个方面的内容： 一：为形成统一编程规范，从编码形式角度出发，本规范对标示符命名、格式与排版、注释等方面进行了详细阐述。 二：为编写出高质量嵌入式软件，从嵌入式软件安全及可靠性出发，本规范对由于C语言标准、C语言本身、C编译器及个人理解导致的潜在危险进行说明及规避。 0.3 适用范围 本规范适用于XXX股份有限公司仪表台秤产品部嵌入式软件的开发，也对其他嵌入式软件开发起一定的指导作用。 0.4 术语定义 0.4.1 规范术语 原则：编程时必须坚持的指导思想。 规则：编程时需要遵循的约定，分为强制和建议（强制是必须遵守的，建议是一般情况下需要遵守，但没有强制性）。 说明：对原则/规则进行必要的解释。 实例：对此原则/规则从正、反两个方面给出例子。 材料：扩展、延伸的阅读材料。 Unspecified：未详细说明的行为，这些是必须成功编译的语言结构，但关于结构的行为，编译器的编写者有某些自由。例如C语言中的“运算次序”问题。这样的问题有 22 个。 在某种方式上完全相信编译器的行为是不明智的。编译器的行为甚至不会在所有可能的结构中都是一致的。 Undefined：未定义行为，这些是本质的编程错误，但编译器的编写者不一定为此给出错误信息。相应的例子是无效参数传递给函数，或函数的参数与定义时的参数不匹配。从安全性角度这是特别重要的问题，因为它们代表了那些不一定能被编译器捕捉到的错误。 Implementation-defined：实现定义的行为，这有些类似于“unspecified ”问题，其主要区别在于编译器要提供一致的行为并记录成文档。换句话说，不同的编译器之间功能可能会有不同，使得代码不具有可移植性，但在任一编译器内，行为应当是良好定义的。 比如用在一个正整数和一个负整数上的整除运算“/ ”和求模运算符“% ”。存在76个这样的问题。 从安全性角度，假如编译器完全地记录了它的方法并坚持它的实现，那么它可能不是那样至关重要。尽可能的情况下要避免这些问题。 0.4.2 C语言相关术语 声明(declaration)：指定了一个变量的标识符，用来描述变量的类型，是类型还是对象，函数等。声明，用于编译器(compiler)识别变量名所引用的实体。以下这些就是声明： extern int bar;! x& [1 k6 U. b8 F- K4 y B8 q
u4 S$ ]: ^0 T2 D
extern int g(int,int);. r3 c( w) @( G6 y7 P
8 x* `4 c# g$ n: h& }/ ]double f(int,double); [ 对于函数声明，extern关键字是可以省略的 。 定义(definition)：是对声明的实现或者实例化。连接器(linker)需要它（定义）来引用内存实体。 与上面的声明相应的定义如下： int bar;9 h; ]* k4 t8 u
. x% O0 a; s0 g, N6 F) V% aint g(int lhs,int rhs)
& K, M$ U; I* D9 E Z/ c/ \7 j( m( Z$ c+ g1 f/ k
{( n! \1 n) [; v/ z0 U
+ ~ ^5 d0 ], O5 x
return lhs*rhs;
7 I/ o' |3 H0 n& |% o' h/ g6 d- o* t9 _& g
}
+ V$ p s. m9 ?# l* I! [! G; Y0 B a5 z% Y+ K0 @; Z7 g; A
double f(int i,double d) {
5 w2 J# D# x+ `( N) e0 z9 R
/ }' |9 n! K$ T1 T3 ~& f4 u4 `2 x returni+d;
( T7 y" G% g6 T3 R( \
2 A: j T, g1 _% ^3 s% T/ H: Y} 0.5 规则的形式 规则/原则<序号>(规则类型)：规则内容。 [原始参考] <序号>：每条规则都有一个序号，序号是按照章节目录-**的形式，从数字1开始。例如，若在此章节有个规则的话，序号为0.5-1。 (规则类型)：或者是‘强制’，或者是‘建议’。 规则内容：此条规则的具体内容。 [原始参考]：指示了产生本条款或本组条款的可应用的主要来源。 [/hide]
7 D2 m* c# ~! b9 ?2 g. O | 
/1 
发表于 2020-4-23 10:05
收藏
淘帖
支持！
反对！
发表于 2020-4-26 16:59
