谈一谈软件的可读性、可修改性和可移植性

U32 const NUMBER_OF_KEYValues = 5;
static U8 keyscan(void) {
U8 key; if((KEYPORT&KEYBIT)!=KEYBIT) {
Delay(100); if((KEYPORT&KEYBIT)!=KEYBIT)
Baidu Nhomakorabea
{ } }
key=((~KEYPORT)&KEYBIT)>>KEYBITNUM; while((KEYPORT&KEYBIT)!=KEYBIT) Delay(100); return key;
后来我又有幸看到了一个外国人写的 LCD 的程序，使我茅塞顿开。原来 程序的可读性，可修改性和可移植性是多么的重要，它可以使你自已和以后可 能要使用你程序的人能够轻松的读懂你的程序，并轻松的修改你的程序，还可 以轻松的使用你的某一模块的程序。而要做到这些绝非易事，里面大有学问！ 所以我们要养成良好的程序编写的习惯，即使写一些小的简单的程序，我们也 要这样要求自已，只有这样，你才能在这一方面做到更好。
Key_None, Key1, Key2, Key3, Key4, key5 } Keys;
typedef enum KeypadButtonsEnum {
One = 0x01, Two = 0x02, Three = 0x03, Four = 0x04, Five=0x08 } KeypadButtons;
可移植性，要求把功能不同的程序段放在不同的 c 文件和 h 文件中，这 样别人就可以方便的使用你某一 c 文件，而不用作大的修改。
最后，大家可以在程序中加入调试的程序段，这样我们就能很容易的发 现程序中出现的问题。
下面是一个简单的键盘，ＬＥＤ灯和串口调试的程序，可以帮助大家理解 上面的内容。 keyboard.c
void Main(void) {
U32 aa; rSYSCFG=CACHECFG;
// Using 8KB Cache//
Port_Init(); #if KD_DEBUG
Uart_Init(0,57600); Delay(10); Uart_Select(0); //Select UART0 Uart_Printf("\nHello, DJT44B0X !"); Uart_Printf("\nPlease Press key"); #endif
void key4on(void) {
LED0OFF; LED1OFF; LED2OFF; }
void key5on(void) {
LED0ON; LED1ON; LED2ON; }
led.h #ifndef _led_h_ #define _led_h_
extern void nokey(void); extern void key1on(void); extern void key2on(void); extern void key3on(void); extern void key4on(void); extern void key5on(void);
可修改性，是便于以后的修改和升级。你就要把那些经常或者可能修改 的地方，放到函数的外面，可以放到 define 的定义里面，或者放到结构体数组 里面。当然要做到可修改性，你可能要在程序中加入一些结构体和数组，还会 多用到一些算法。这样会增加程序的大小，但是从长远考虑，比起你以后修改 的时间和精力，这是微不足道的。
void nokey(void) { }
void key1on(void) {
LED0ON; LED1OFF; LED2OFF; }
void key2on(void) {
LED0OFF; LED1ON; LED2OFF; }
void key3on(void) {
LED0OFF;
LED1OFF; LED2ON; }
void printfkey2(U32 printfnum) {
Uart_Printf("\nkey%d press!",printfnum); }
void printfkey3(U32 printfnum) {
Uart_Printf("\nkey%d press!",printfnum); }
void printfkey4(U32 printfnum) {
谈一谈软件的可读性、可修改性和可移植性 (2007-09-29 10:35) 对于从事软件设计的程序员来说，不管是做上位机的软件设计还是做单
片机等嵌入式的设计，往往更注重于程序执行的结果，而忽视了程序的可读性， 可修改性和可移植性。特别是国内的程序员，因为国内在这一方面还没有引起 足够的重视，在软件工程方面的教育太少，关于软件工程的书籍也太少。我在 大学的时候因为要参加高级程序员的考试，所以对软件工程有过一定的了解。 但是由于当时并没有太多实践的机会，所以也没有深入的理解。工作以后我也 开发过一些程序，但是同大多数程序员一样，我并没有过多的考虑程序的可读 性，可修改性和可移植性。直到有一天，我要对原来的程序作一些大的修改的 时候，我才尝到了苦果，这种修改跟重新写一遍程序一样花费了我大量的时间 和精力。
#endif
main.c #include "option.h" #include "def.h" #include "44b.h" #include "44blib.h" #include "keyboard.h" #include "led.h" #include "serial.h" #include "beep.h" #include "timer.h" #include"rtc.h"
while(1) {
aa= TranslateKey(); if(aa) {
(*ledfun[aa])(); #if KD_DEBUG
(*serialfun[aa])(aa); #endif } } } 44b.h 是外面寄存器的定义，def.h 是数据类型的定义，44blib.c 包含 端口初始化和串口初始化和串口发送的函数。 虽是一个简单的程序，但是也可以帮助我们初步理解程序的可读性，可 修改性和可移植性。有一些做的不好的地方还请大家指正，希望大家能有所收 获！
typedef struct keynumstruct {
U8 KeyValue; U32 KeyIndex; } keynum;
keynum const keyValues[] = {
{ One, Key1}, { Two, Key2 }, { Three, Key3 }, { Four, Key4 }, {Five,key5} };
while(B_Min <= B_Max) {
B_Offset = (B_Max + B_Min) / 2; B_Result = keyValues[B_Offset].KeyValue; if (B_Result == B_Value) {
return(keyValues[B_Offset].KeyIn dex);
extern U32 TranslateKey(void);
#endif led.c #include"44b.h" #include"led.h"
#define LEDPORT rPDATC #define LED0 0x02 #define LED1 0x04 #define LED2 0x08 #define LED0ON LEDPORT|=LED0 #define LED1ON LEDPORT|=LED1 #define LED2ON LEDPORT|=LED2 #define LED0OFF LEDPORT&=(~LED0) #define LED1OFF LEDPORT&=(~LED1) #define LED2OFF LEDPORT&=(~LED2)
#define KD_DEBUG 1
void (*ledfun[])(void)= {
nokey, key1on, key2on, key3on, key4on, key5on };
void (*serialfun[])(U32 printfnum)= {
printfkey0, printfkey1, printfkey2, printfkey3, printfkey4, printfkey5 };
} else {
if (B_Result > B_Value) { B_Max = B_Offset - 1; } else {
B_Min = B_Offset + 1; } } } return 255; // invalid key } return 0; // key none }
keyboard.h #ifndef _keyboard_h_ #define _keyboard_h_
extern void printfkey0(U32 printfnum); extern void printfkey1(U32 printfnum); extern void printfkey2(U32 printfnum); extern void printfkey3(U32 printfnum); extern void printfkey4(U32 printfnum); extern void printfkey5(U32 printfnum);
#include"44b.h" #include"44blib.h" #include"Def.h" #include"keyboard.h"
#define KEYPORT rPDATG #define KEYBIT 0xf0 #define KEYBITNUM 4
typedef enum KeysEnum {
} return 0;
U32 TranslateKey(void) {
U32 B_Result; U8 B_Offset; U32 B_Min = 0; U32 B_Max = NUMBER_OF_KEYValues - 1; U8 B_Value = keyscan();
if (B_Value) {
从表面上看，可读性比较简单，它包括程序的格式和注释。但是深入的 理解我们却发现，他和可修改性、可移植性密不可分，因为如果你不能了解程 序员的编程的思想你就无法读懂他的程序，而程序员为了做到可修改性和可移 植性，有编程当中必然会使用很多好的思想和方法。你要让别人容易读懂你的 程序，你就得考虑这些。还有关于函数和变量的命名，一定要用它的含义来命 名。构建函数的时候一定要考虑函数的功能尽量简明，可以多用函数，最好不 要一个函数实现多个功能。
Uart_Printf("\nkey%d press!",printfnum); }
void printfkey5(U32 printfnum) {
Uart_Printf("\nkey%d press!",printfnum); }
serial.h #ifndef _serial_h_ #define _serial_h_
#endif serial.c #include"def.h" #include"44blib.h" #include"serial.h"
void printfkey0(U32 printfnum) { }
void printfkey1(U32 printfnum) {
Uart_Printf("\nkey%d press!",printfnum); }