学习一下嵌入式C51相关规范

mytomorrow

为单片机编写C51代码，程序的可行性当然是必须保证的。但是包括笔者在内的很多新手，都忽略了程序的另一面——可读性、可维护性以及可扩展性。只要稍微有些嵌入式开发经验的读者，若看到笔者在“Zigbee之旅”系列博文中的源码，可能都会从其代码编写习惯中得出一个结论——“菜鸟”。呵呵，笔者决定抽时间学习一下C51嵌入式开发的编程规范，于是在网上收集了一些资料，结合自己的经验，一并分享如下。

一、注释

（1）文件注释

　　这里说的文件，一般是 .h 和 .c 文件。

+ B! z7 J: n0 K& S" G5 Z0 A$ N- S' R/***********************************************************
% y: [9 c, E8 @$ g) T+ w文件名称： hal.h
1 a% }; X" U% b( [% @9 |  c* t* G作 者：
& Y$ N2 |. ~% I: a. M, U1 O- |- c  C日 期：　
, ^) g9 M% X7 P; Y1 R- ?& P( g6 q版 本： 1.1
8 P0 Z1 o, Q6 ^) M; b  I; k功能说明： 硬件抽象层
6 g1 U/ |6 g5 I7 g函数列表： （略）
修改记录：
' l5 E, t) h- k' t% U' `% {* ?/ {) @0 d, a***********************************************************/
4 R5 L3 y3 U4 \. I1 E

　　其实一个人学习的话，诸如“文件名称”、“作者”、“版本”、“日期”这些内容，不是特别必要。上述的规范一般在公司内要求比较严格（在多人作业的情况下，对于软件开发的流程控制非常重要）。

　　但“说明”和“函数列表”这两项，我想还是方便的话写写比较好。当你对这个项目比较淡忘的时候，你只需要扫一下文件头部注释，就能一下子知道这个文件到底是干什么的，明白都有哪些函数。

（2）函数注释

　　如果对上述的文件注释不怎么感冒的话，我想大家函数注释都应比较熟悉。博客园的园友中大多都是使用vs的，相信vs中对函数注释的支持一定不会忘记（敲三个///，啥都出来了，只需要一个个填就行）。虽然嵌入式开发IDE没有如此强大的功能，但是还是很有必要对“函数功能”、“入口参数”、“出口参数”进行说明：

5 A9 R$ Q2 t6 u5 n# A

游客，如果您要查看本帖隐藏内容请回复

  u: m  G3 e5 |+ P
  ~' S9 i8 E' e: s+ }! k$ X

- A( l5 A; X  f+ o
5 O5 a; x) M$ w* Y, R* T1 ]  ~

artic

看看嵌入式C51相关规范。