01. FreeRTOS编码标准
FreeRTOS核心的源代码遵从MISRA编码标准指南。这个标准篇幅稍长，大家可以在MISRA官方网站找到对应的文档。
  k/ q" _6 h# V
1 K0 w. B# t0 x4 t2 ?0 h5 BFreeRTOS源代码不符合MISRA标准的项目如下所示：
9 L5 |# ^' Q# ~& K  z. m4 y* u5 ]8 O
1.有两个API函数有多个返回点。MISRA编码标准强制规定：一个函数在其结尾应该有单一的返回点。

/ B; ~( ^1 G& k; z% k$ U3 O2.指针算数运算，在创建任务时，为了兼容8、16、20、24、32位总线，不可避免的使用了指针算数运算。MISRA编码标准强制规定：指针的算术运算只能用在指向数组或数组元素的指针上。

7 {9 N- ^( H% m1 ~# v" d3.默认情况下，跟踪宏为空语句，因此不符合MISRA的规定。MISRA编码标准强制规定：预处理指令在句法上应该是有意义的。
5 a+ o0 [& p% X, @, V7 D' Y$ D
FreeRTOS可以在很多不同编译器中编译，其中的一些编译器比同类有更高级特性。因为这个原因，FreeRTOS不使用任何非C语言标准的特性或语法。一个例外情况是头文件stdint.h。在文件夹FreeRTOS/include下包含一个叫做stdint.readme的文件，如果你的编译器不提供stdint类型定义，可以将stdint.readme文件重命名为stdint.h。
) e! z5 P4 D/ Z6 }8 \) y
02. FreeRTOS变量命名规则
+ s% M, E+ C8 G, q- Ouint32_t类型的变量使用前缀ul，这里’u’表示’unsigned’，’l’表示’long’
6 r) V- B& k( P. d# auint16_t类型的变量使用前缀us，这里’u’表示’unsigned’，’s’表示’short’
4 R8 C' P0 t8 h- s# _2 wuint8_t类型的变量使用前缀uc，这里’u’表示’unsigned’，’c’表示’char’
非stdint类型的变量使用前缀x，比如基本的Type_t和TickType_t类型，这些类型在移植层定义，定义成符合处理器架构的最高效类型；
非stdint类型的无符号变量使用前缀ux，比如UbaseType_t（unsigned BaseType_t）
size_t类型的变量使用前缀x；
' W5 |- V( l1 N/ M5 Z7 p3 ?# l枚举类型变量使用前缀e
指针类型变量在类型基础上附加前缀p，比如指向uint16_t的指针变量前缀为pus
8 v& d1 a. Q% J$ S与MISRA指南一致，char类型变量仅被允许保存ASCII字符，前缀为c
与MISRA指南一致，char *类型变量仅允许指向ASCII字符串，前缀为pc
! J& S+ Y8 ~: \03. FreeRTOS函数命名规则
在文件作用域范围的函数前缀为prv
API函数的前缀为它们的返回类型，当返回为空时，前缀为v
6 [0 @4 [7 h8 I8 }9 `API函数名字起始部分为该函数所在的文件名。比如vTaskDelete函数定义在tasks.c，并且该函数返回空。
# l8 i- a3 [# O) G) E( j* Z
04. FreeRTOS宏命名规则
宏的名字起始部分为该宏定义所在的文件名的一部分。比如configUSE_PREEMPTION定义在FreeRTOSConfig.h文件中。
/ U) q6 B" i1 v3 S7 E除了前缀，宏剩下的字母全部为大写，两个单词间用下划线（’_’）隔开。
. c* F% ]: K8 r0 X+ ]" ]
. E7 X: W9 t& [  c& I9 T2 _1 B05. FreeRTOS数据类型
只有stdint.h和RTOS自己定义的数据类型可以使用，但也有例外情况，如下所示：
5 ]* ]6 n2 U3 a( u5 A
1.char：与MISRA编码标准指南一致，char类型变量仅被允许保存ASCII字符
) s) E6 h9 _/ N2 R
5 R/ U# l: h5 W5 W$ x2.char *：与MISRA编码标准指南一致，char *类型变量仅允许指向ASCII字符串。当标准库函数期望一个char *参数时，这样做可以消除一些编译器警告；特别是考虑到有些编译器将char类型当做signed类型，还有些编译器将char类型当做unsigned类型。


有三种类型会在移植层定义，它们是：
. @" L6 j& M+ m  u1 U
1.TickType_t：如果configUSE_16_BIT_TICKS为非零（条件为真），TickType_t定义为无符号16位类型。如果configUSE_16_BIT_TICKS为零（条件为假），TickType_t定义为无符号32位类型。注：32位架构的微处理器应设置configUSE_16_BIT_TICKS为零。
3 D+ r8 M4 y; u: T8 {' s
$ M# _* v& V9 g& j1 {2.BaseType_t：定义为微处理器架构效率最高的数据类型。比如，在32位架构处理器上，BaseType_t应该定义为32位类型。在16位架构处理器上，BaseType_t应该定义为16位类型。如果BaseType_t定义为char，对于函数返回值一定要确保使用的是signed char，否则可能造成负数错误。
! s3 z/ y% t3 E5 m
UbaseType_t：这是一个无符号BaseType_t类型

06. 其它
风格说明
% L5 Y) g$ a4 d4 K8 H  G8 V2 f7 C1.缩进：缩进使用制表符，一个制表符等于4个空格。
2.注释：注释单行不超过80列，特殊情况除外。不使用C++风格的双斜线（//）注释
3.布局：FreeRTOS的源代码被设计成尽可能的易于查看和阅读。下面的代码片中，第一部分展示文件布局，第二部分展示C代码设计格式。
9 T8 n6 @3 |: U- o2 d% h0 I& C: ^
9 f( Q. ]# h( e& O1 ^" i6 m1 u示例

" p# t* m$ T. C2 h# {. A7 h2 n

1. /* 首先在这里包含库文件... */  
   
2. #include <stdlib.h>  
   
3. 
   
4. /* 然后是FreeRTOS的头文件... */  
   
5. #include "FreeRTOS.h"  
   
6. 
   
7. /* 紧接着包含其它头文件. */  
   
8. #include "HardwareSpecifics.h"  
   
9. 
   
10. /* 随后是#defines, 在合理的位置添加括号. */  
    5 m' A/ {2 N3 P. C: }( z$ P. S
11. #define A_DEFINITION    ( 1 )  
    1 q2 U. N% D! k5 e# Q
12. 
    : ?. w* b" X- `5 p" }% |7 H# t" p
13. /*
    
14. * 随后是Static (文件内部的)函数原型,  
    7 j4 y6 c( `  W  X5 ~0 F
15. * 如果注释有多行，参照本条注释风格---每一行都以’*’起始.
    
16. */  
    
17. static void prvAFunction( uint32_t ulParameter );  
    
18. 
    
19. /* 文件作用域变量（本文件内部使用）紧随其后，要在函数体定义之前. */  
    1 ^+ W2 m7 T5 d' g+ w; E) S
20. static BaseType_t xMyVariable.  
    : J" ^0 V2 {# J, o, l
21. 
    $ D, j& d! j* ~' ]
22. /* 每一个函数的结束都有一行破折号，破折号与下面的第一个函数之间留一行空白。*/  
    6 s4 O5 o! k9 x2 Y5 P) u
23. 
    
24. /*-----------------------------------------------------------*/  
    / G6 B0 x7 v% B) G8 n# q# m  Y- n
25. 
    
26. void vAFunction( void )  
    ) g6 K- U# Q+ w0 Z% T0 ?
27. {  
    
28.      /* 函数体在此定义，注意要用大括号括住 */  
    
29. }  
    " n9 _. ]$ ^4 t. W
30. /*-----------------------------------------------------------*/  
    
31. 
    
32. static UBaseType_t prvNextFunction( void )  
    
33. {  
    1 p* X9 @8 }3 K$ ^! n/ v$ ]
34.      /* 函数体在此定义. */  
    & F: u5 M; i3 t' A! S- G* [7 R8 _& m
35. }  
    : ?2 M. E) ?* f! M- h
36. /*-----------------------------------------------------------*/
    % {. A  e! Q* U" f! V, Y
37. 
    
38. /*
    4 c. q  G( x& h2 b
39. * 函数名字总是占一行，包括返回类型。 左括号之前没有空格左括号之后有一个空格，
    # x" J9 s% M$ N' Z: |/ Q
40. * 每个参数后面有一个空格参数的命名应该具有一定的描述性.
    4 @# v# h( `9 }
41. */  
    
42. void vAnExampleFunction( long lParameter1, unsigned short usParameter2 )
    # ~/ ~2 G( r: n9 m, |
43. {  
    # b9 G; I( x1 P7 q
44. /* 变量声明没有缩进. */  
    
45. uint8_t ucByte;  
    " i% {, `6 C( t! E" c1 _0 A
46. 
    8 ]: O* |$ y/ j( [
47.     /* 代码要对齐.  大括号占独自一行. */  
    : @0 j* t6 j  ]1 F9 g
48.     for( ucByte = 0U; ucByte < fileBUFFER_LENGTH; ucByte++ )  
    $ l+ Z0 T4 D; R: R# x; S* P& ~& v
49.     {  
    4 J* w* _% G( y( |
50.          /* 这里再次缩进. */  
    
51.     }  
    
52. }  
    7 s- E+ J  I2 ^: @0 S' e9 x' G/ t
53. 
    
54. /*
    8 ?3 c. @& p9 N
55. * for、while、do、if结构具有相似的模式。这些关键字和左括号之间没有空格。
    
56. * 左括号之后有一个空格，右括号前面也有一个空格，每个分号后面有一个空格。
    
57. * 每个运算符的前后各一个空格。使用圆括号明确运算符的优先级。不允许有0
    
58. * 以外的数字（魔鬼数）出现，必要时将这些数字换成能表示出数字含义的常量或
    4 e* a* m% u! d0 P- U9 R
59. * 宏定义。
    
60. */  
    ( O, b& Y, y) F
61. for( ucByte = 0U; ucByte < fileBUFFER_LENGTH; ucByte++ )  
    
62. {  
    
63. }  
    
64. 
    ! A" ?- e$ l# a! v& a2 N
65. while( ucByte < fileBUFFER_LENGTH )  
    
66. {  
    2 N- L1 d" u! ^2 G. R
67. }  
    
68. 
    , W' N3 L- b8 q
69. /*
    
70. * 由于运算符优先级的复杂性，我们不能相信自己对运算符优先级时刻保持警惕
    & _8 i1 B7 i# L  J3 f
71. * 并能正确的使用，因此对于多个表达式运算时，使用括号明确优先级顺序
    0 K+ i6 M7 b% t0 |( B7 D
72. */  
      j7 h6 g* W; l- G- Q( M
73. if( ( ucByte < fileBUFFER_LENGTH ) && ( ucByte != 0U ) )  
    
74. {  
    ) |: B' y( w, f- p, L$ J
75.     ulResult = ( ( ulValue1 + ulValue2 ) - ulValue3 ) * ulValue4;  
    " v* q# J3 L, w' r0 ~4 X
76. }  
    
77. 
    & [* U5 X) N7 q
78. /* 条件表达式也要像其它代码那样对齐。 */  
    4 h0 Y+ H" A% n6 u
79. #if( configUSE_TRACE_FACILITY == 1 )  
    ; M/ [3 s$ h' ~# c0 t) p7 q/ n
80. {  
    
81.      /* 向TCB增加一个用于跟踪的计数器. */  
    7 N* x: T& e% X0 [( v6 g
82.      pxNewTCB->uxTCBNumber = uxTaskNumber;  
    : Z- n6 f. t- O/ p8 X+ z
83. }  
    & H0 w% y2 D5 x! b
84. #endif  
    
85. 
    
86. /*方括号前后各留一个空格*/  
    + c, Y  _  e6 P* S/ v" p$ O
87. ucBuffer[ 0 ] = 0U;  
    
88. ucBuffer[ fileBUFFER_LENGTH - 1U ] = 0U;

复制代码

3 P+ J9 O! ]4 L9 o