EDA365欢迎您登录！
您需要 登录 才可以下载或查看，没有帐号？注册
x
/ ^# B# N5 P! r7 v s
为单片机编写C51代码，程序的可行性当然是必须保证的。但是包括笔者在内的很多新手，都忽略了程序的另一面——可读性、可维护性以及可扩展性。只要稍微有些嵌入式开发经验的读者，若看到笔者在“Zigbee之旅”系列博文中的源码，可能都会从其代码编写习惯中得出一个结论——“菜鸟”。呵呵，笔者决定抽时间学习一下C51嵌入式开发的编程规范，于是在网上收集了一些资料，结合自己的经验，一并分享如下。 一、注释（1）文件注释 这里说的文件，一般是 .h 和 .c 文件。
- L- @+ `! a7 W& F4 U/***********************************************************, T, Y* p. R; X% g5 n
文件名称： hal.h% O- A- r5 ?; \8 l0 K: ~' q
作 者：
. t; n3 F% a$ ^" @" m- c0 e日 期： & N7 _ x$ T. f
版 本： 1.14 |4 C/ C% O5 x5 L( f. j; ^- {2 {
功能说明： 硬件抽象层
! e6 q( e/ e' D% L+ S- q函数列表： （略）
; {# m$ c* S* v( O! h0 k0 x修改记录：
, ` [1 n2 t# U5 w4 |9 y& Y9 B8 X***********************************************************/
! ~# d b( m3 e& a, f o( W4 {$ P+ f/ ^
! S( O+ t) E$ K; W6 @1 d
) _6 S, m* K5 l 其实一个人学习的话，诸如“文件名称”、“作者”、“版本”、“日期”这些内容，不是特别必要。上述的规范一般在公司内要求比较严格（在多人作业的情况下，对于软件开发的流程控制非常重要）。 但“说明”和“函数列表”这两项，我想还是方便的话写写比较好。当你对这个项目比较淡忘的时候，你只需要扫一下文件头部注释，就能一下子知道这个文件到底是干什么的，明白都有哪些函数。 （2）函数注释 如果对上述的文件注释不怎么感冒的话，我想大家函数注释都应比较熟悉。博客园的园友中大多都是使用vs的，相信vs中对函数注释的支持一定不会忘记（敲三个///，啥都出来了，只需要一个个填就行）。虽然嵌入式开发IDE没有如此强大的功能，但是还是很有必要对“函数功能”、“入口参数”、“出口参数”进行说明： 6 _) U q, A) l' X {
! S& [# p6 K- }3 P8 |6 b9 |% }1 |/ @2 c5 \! h
6 }$ I8 R6 A9 X; D0 y. m C
; u+ c5 } f7 G+ | x2 u
. G2 z, u4 y h' U; ?# z
/ U4 u6 {4 h* `% a | 
/1 
发表于 2019-9-17 17:16
收藏
淘帖
支持！
反对！