作為一個初學(xué)者如何具有良好的程序設(shè)計風(fēng)格呢?我想引用一個關(guān)于初學(xué)者請教編程大師的故事讓讀者自己去領(lǐng)悟。
有一位編程大師,他寫非結(jié)構(gòu)化的程序,一位初學(xué)者刻意模仿他,也寫非結(jié)構(gòu)化的程序。當(dāng)他讓大師看他的進(jìn)步時,大師批評了他的非結(jié)構(gòu)化程序:“ 對一位編程大師合適的東西未必對一個初學(xué)者同樣合適,在超越結(jié)構(gòu)化之前,你必須理解編程之道。” 我個人認(rèn)為作為一個初學(xué)者應(yīng)該踏踏實實的打好程序設(shè)計的基礎(chǔ),不要急功近利,舍本逐末。我走過不少彎路,希望大家能和我一樣能牢記編程大師的忠告:“對編程大師合適的東西未必對一個初學(xué)者同樣合適”。
本文所描述的優(yōu)秀編程風(fēng)格適合于大部分語言,文章中可能提到你不是很了解的概念,沒有關(guān)系,你放心的讀下去,當(dāng)你使用AVR一個月之后,你什么都明白了。
AVRc語言優(yōu)秀編程風(fēng)格
文件結(jié)構(gòu)
模塊化的程序應(yīng)該是有一個很好的程序結(jié)構(gòu)的。AVRC語言程序有兩種用戶文件,.c程序文件,.h頭文件,程序中編寫過程中需要在.c文件中包含.h頭文件。初學(xué)者往往出現(xiàn)重復(fù)包含或者頭文件包含錯誤的問題,我當(dāng)時也時常為這種錯誤而發(fā)愁。下面我以我寫的電機(jī)驅(qū)動例程來給大家說明一下,優(yōu)秀的編程文件結(jié)構(gòu)。
這個工程中有8個文件,一個說明文件,如下圖:下載程序例子 電機(jī)控制案例 。
我寫的成型的程序的文件個數(shù)基本上都是偶數(shù),因為每一個結(jié)構(gòu)化的函數(shù)定義.c文件都會對應(yīng)一個.h文件。main.c對應(yīng)config.h。我們來看看各文件的包含關(guān)系。下面我們看看這些文件的包含關(guān)系與內(nèi)容:[推薦的文件包含順序與關(guān)系]
所有.c文件都包含了config.h文件。如:#i nclude “config.h”
在config.h 中有如下代碼:
?。 nclude “delay.h”
?。 nclude “device_init.h”
?。 nclude “motor.h”
這樣做就不容易出現(xiàn)錯誤的包含關(guān)系,為了預(yù)防萬一,我們還引入了宏定義與預(yù)編譯。如下:
#ifndef _UNIT_H__
#define _UNIT_H__ 1
//100us
extern void Delay100us(uint8 n);
//1s
extern void Delay1s(uint16 n); // n <= 6 ,when n==7, it is 1.
//1ms
extern void Delay1ms(uint16 n);
#endif
第一次包含本文件的時候正確編譯,并且#define _UNIT_H__ 1,第二次包含本文件#ifndef _UNIT_H__就不再成立,跳過文件。
預(yù)編譯還有更多的用途,比如可以根據(jù)不同的值編譯不同的語句,如下:
//#pragma REGPARMS
#if CPU_TYPE == M128
?。 nclude
#endif
#if CPU_TYPE == M64
?。 nclude
#endif
#if CPU_TYPE == M32
?。 nclude
#endif
#if CPU_TYPE == M16
?。 nclude
#endif
#if CPU_TYPE == M8
?。 nclude
#endif
?。 nclude
變量名與函數(shù)名
變量以及函數(shù)命名應(yīng)該按照盡量短,按需長,具有實際意義??梢酝ㄟ^下劃線或者大小寫結(jié)合的方法組合動詞和名詞組成變量函數(shù)名。下面對比好的命名方法與不好的命名方法:
好的: Delay100us();
不好的: Yanshi();
好的: init_devices();
不好的: Chengxuchushihua();
好的: int temp;
不好的: int dd;
外部調(diào)用
首先在模塊化程序的.h文件中定義extern
//端口初始化
extern void port_init(void);
//T2初始化
void timer2_init(void);
//各種參數(shù)初始化
extern void init_devices(void);模塊化程序的.c文件中定義函數(shù),不要在模塊化的程序中調(diào)用程序,及不要出現(xiàn)向timer2_init();這樣函數(shù)的使用,因為你以后不知道你到底什么地方調(diào)用了函數(shù),導(dǎo)致程序調(diào)試難度增加??梢栽诙x函數(shù)的過程中調(diào)用其他函數(shù)作為函數(shù)體。
/**************************采用timer2 產(chǎn)生波形***********************/
// PWM頻率 = 系統(tǒng)時鐘頻率/(分頻系數(shù)*2*計數(shù)器上限值))
void timer2_init(void)
{
TCCR2 = 0x00; //stop
TCNT2= 0x01; //set count
OCR2 = 0x66; //set compare
TCCR2 = (1<
//占空比=高比低為:(OCR2-0X01)/(0XFF-OCR2) OX01++++++(OCR2)__________OXFF (+表示輸出高,_表示輸出低)
//即OCR2越大,輸出越大
}在少數(shù)幾個文件中調(diào)用函數(shù),在main.c中調(diào)用大部分函數(shù),在interupts.c中根據(jù)不同的中斷調(diào)用服務(wù)函數(shù)。
void main(void)
{
/******************************************************************************/
//初始工作
/******************************************************************************
init_devices();
while(1)
{
for_ward(0); //默認(rèn)速度運(yùn)轉(zhuǎn) 正
Delay1s(5); //延時5s
motor_stop(); //停止
Delay1s(5); //延時5s
back_ward(0); //默認(rèn)速度運(yùn)轉(zhuǎn) 反
Delay1s(5); //延時5s
speed_add(20); //加速
Delay1s(5); //延時5s
speed_subtract(20); //減速
Delay1s(5); //延時5s
}
}
宏定義
宏定義主要用于兩個地方:
一是用得非常多的命令或語句,利用宏將其簡化。
#ifndef TRUE
#define TRUE 1
#endif
#ifndef FALSE
#define FALSE 0
#endif
#ifndef NULL
#define NULL 0
#endif
#define MIN(a,b) ((a
#define MAX(a,b) ((a>b)?(a):(b))
#define ABS(x) ((x>)?(x):(-x))
typedef unsigned char uint8; /* 定義可移植的無符號8位整數(shù)關(guān)鍵字 */
typedef signed char int8; /* 定義可移植的有符號8位整數(shù)關(guān)鍵字 */
typedef unsigned int uint16; /* 定義可移植的無符號16位整數(shù)關(guān)鍵字 */
typedef signed int int16; /* 定義可移植的有符號16位整數(shù)關(guān)鍵字 */
typedef unsigned long uint32; /* 定義可移植的無符號32位整數(shù)關(guān)鍵字 */
typedef signed long int32; /* 定義可移植的有符號32位整數(shù)關(guān)鍵字 */
二是利用宏定義方便的進(jìn)行硬件接口操作,再程序需要修改時,只需要修改宏定義即可,而不需要滿篇去找命令行,進(jìn)行修改。
//PD4,PD5 電機(jī)方向控制 如果更改管腳控制電機(jī)方向,更改PORTD |= 0x10即可。
#define moto_en1 PORTD |= 0x10
#define moto_en2 PORTD |= 0x20
#define moto_uen1 PORTD &=~ 0x10
#define moto_uen2 PORTD &=~ 0x20
//啟動TC2定時比較和溢出
#define TC2_EN TIMSK |= (<<1OCIE2)|(1<
//禁止TC2再定時比較和溢出
#define TC2_DIS TIMSK &=~ (1<
為了增加程序的可讀性,方便合作者讀動程序,或者程序作者在一段時間之后還能看懂程序,我們需要在程序中寫 注釋。
在比較特殊的函數(shù)使用或者命令調(diào)用的地方加單行注釋。使用方法為:
Tbuf_putchar(c,RTbuf); // 將數(shù)據(jù)加入到發(fā)送緩沖區(qū)并開中斷
extern void Delay1s(uint16 n); // n <= 6 ,when n==7, it is 1. 在模塊化的函數(shù)中使用詳細(xì)段落注釋:
/***********************
** 函數(shù)名稱: Com_putchar
** 功能描述: 從串行口輸出一個字符c
** 輸 入: c:輸出字符
** 輸出 : 0:失敗 1:成功
** 全局變量: 無
** 調(diào)用模塊:
** 說明:
** 注意:
********************/
在文件頭上加文件名,文件用途,作者,日期等信息。
/*********************************************************************************************************
** serial driver
** (c) Copyright 2005-2006, limaokui
** All Rights Reserved
**
** V1.1.0
**--------------文件信息--------------------------------------------------------------------------------
**文 件 名:sio.c
**創(chuàng) 建 人: 李茂奎
**最后修改日期: 2005年7月13日
**描 述: serial driver
**--------------歷史版本信息----------------------------------------------------------------------------
** 創(chuàng)建人: 李茂奎
** 版 本: V1.00
** 日 期: 2005年7月13日
** 描 述: 原始版本
*********************************************************************************************************/
要清楚,注釋是為了方便閱讀,增強(qiáng)程序的可度性,不要本末倒置,不要給很簡單大家都能看明白的程序加注釋,不要讓注釋淹沒了你的程序結(jié)構(gòu)。對于函數(shù),變量等盡量使用文件名自注釋的方法,及通過文件名就可以知道意思。