|
|||||||||||
| 技術(shù)交流 | 電路欣賞 | 工控天地 | 數(shù)字廣電 | 通信技術(shù) | 電源技術(shù) | 測(cè)控之家 | EMC技術(shù) | ARM技術(shù) | EDA技術(shù) | PCB技術(shù) | 嵌入式系統(tǒng) 驅(qū)動(dòng)編程 | 集成電路 | 器件替換 | 模擬技術(shù) | 新手園地 | 單 片 機(jī) | DSP技術(shù) | MCU技術(shù) | IC 設(shè)計(jì) | IC 產(chǎn)業(yè) | CAN-bus/DeviceNe |
(分享)收集的C51的編程規(guī)范 |
| 作者：菠蘿頭 欄目：單片機(jī) |
編程首要是要考慮程序的可行性，然后是可讀性、可移植性、健壯性以及可測(cè)試性。這是總則。但是很多人忽略了可讀性、可移植性和健壯性(可調(diào)試的方法可能歌不相同)，這是不對(duì)的。 1.當(dāng)項(xiàng)目比較大時(shí)，最好分模塊編程，一個(gè)模塊一個(gè)程序，很方便修改，也便于重用和便于閱讀。 2.每個(gè)文件的開(kāi)頭應(yīng)該寫(xiě)明這個(gè)文件是哪個(gè)項(xiàng)目里的哪個(gè)模塊，是在什么編譯環(huán)境下編譯的，編程者(/修改者)和編程日期，值得注意的是一定不要忘了編程日期，因?yàn)橐院竽阍倏次募䲡r(shí)，會(huì)知道大概是什么時(shí)候編寫(xiě)的，有些什么功能，并且可能知道類似模塊之間的差異(有時(shí)同一模塊所用的資源不同，和單片機(jī)相連的方法也不同，或者只是在原有的模塊上加以改進(jìn))。 3.一個(gè)C源文件配置一個(gè)h頭文件或者整個(gè)項(xiàng)目的C文件配置一個(gè)h頭文件，我自己采用整個(gè)項(xiàng)目的C文件配置一個(gè)h頭文件的方法，并且使用#ifndef/#define/#endif的宏來(lái)防止重復(fù)定義，方便各模塊之間相互調(diào)用。 4.一些常量(如圓周率PI)或者常需要在調(diào)試時(shí)修改的參數(shù)最好用#define定義，但要注意宏定義只是簡(jiǎn)單的替換，因此有些括號(hào)不可少。 5.不要輕易調(diào)用某些庫(kù)函數(shù)，因?yàn)橛行⿴?kù)函數(shù)代碼很長(zhǎng)(我是反對(duì)使用printf之類的庫(kù)函數(shù)的，但是是一家之言，并不勉強(qiáng)各位)。 6.書(shū)寫(xiě)代碼時(shí)要注意括號(hào)對(duì)齊，固定縮進(jìn)，一個(gè){}各占一行，我本人采用采用所進(jìn)4個(gè)字符，應(yīng)該還是比較合適的，if/for/while/do等語(yǔ)句各占一行，執(zhí)行語(yǔ)句不得緊跟其后，無(wú)論執(zhí)行語(yǔ)句多少都要加{},千萬(wàn)不要寫(xiě)成如下格式： for(i=0;i<100;i++){fun1();fun2();} for(i=0;i<100;i++){ fun1(); fun2(); } 而應(yīng)該寫(xiě)成： for(i=0;i<100;i++) { fun1(); fun2(); } 7.一行只實(shí)現(xiàn)一個(gè)功能，比如： a=2;b=3;c=4;宜改成： a=2; b=3; c=4; 8.重要難懂的代碼要寫(xiě)注釋，每個(gè)函數(shù)要寫(xiě)注釋，每個(gè)全局變量要寫(xiě)注釋，一些局部變量也要寫(xiě)注釋。注釋寫(xiě)在代碼的上方或者右方，千萬(wàn)不要寫(xiě)在下方(相信沒(méi)有人寫(xiě)在左方吧:))。 9.對(duì)各運(yùn)算符的優(yōu)先級(jí)右所了解，記不得沒(méi)關(guān)系，加括號(hào)就是，千萬(wàn)不要自作聰明說(shuō)自己記得很牢。 10.不管有沒(méi)有無(wú)效分支，SWITCH函數(shù)一定要defaut這個(gè)分支。一來(lái)讓閱讀者知道程序員并沒(méi)有遺忘default,并且防止程序運(yùn)行過(guò)程中出現(xiàn)的意外(健壯性)。 11.變量和函數(shù)的命名最好能做到望文生義。不要命名什么x，y，z，a，sdrf之類的名字。 12.函數(shù)的參數(shù)和返回值沒(méi)有的話最好使用void。 13.goto語(yǔ)句：從匯編轉(zhuǎn)型成C的人很喜歡用goto，但goto是C語(yǔ)言的大忌，但是老實(shí)說(shuō)，程序出錯(cuò)是程序員自己造成的，不是goto的過(guò)錯(cuò)；本人只推薦一種情況下使用goto語(yǔ)句，即從多層循環(huán)體中跳出。 14.指針是C語(yǔ)言的精華，但是在C51中我個(gè)人認(rèn)為少用為妙，一來(lái)有時(shí)反而要花費(fèi)多的空間，還有在對(duì)片外數(shù)據(jù)進(jìn)行操作時(shí)會(huì)出錯(cuò)(可能是時(shí)序的問(wèn)題)。 15.一些常數(shù)和表格之類的應(yīng)該放到code去中以節(jié)省RAM。 16.程序編完編譯看有多少code多少data，注意不要使堆棧為難。 17.程序應(yīng)該要能方便的進(jìn)行測(cè)試，其實(shí)這也與編程的思維有關(guān)；一般有三種：一種是自上而下先整體再局部；一種是自下而上先局部再整體；還有一種是結(jié)合兩者往中間湊。我的做法是現(xiàn)大概規(guī)劃一下整個(gè)編程，然后一個(gè)模塊模塊獨(dú)立編程，每個(gè)模塊調(diào)試成功再拼湊在一塊調(diào)試。我建議：如果程序不大，可以直接用一個(gè)文件直接編，如果程序很大，宜采用自上而下的方式，但更多的是那種處在中間的情況，宜采用自下而上或者結(jié)合的方式。 電子牛 發(fā)表于 2005-6-7 18:14:00 //以下是《模塊》或《文件》注釋內(nèi)容： ///////////////////////////////////////////////////////////////////// //公司名稱： //模 塊 名： //創(chuàng) 建 者： //修 改 者： //功能描述： //其他說(shuō)明： //版 本： ///////////////////////////////////////////////////////////////////// //以下是《函數(shù)》注釋內(nèi)容： ///////////////////////////////////////////////////////////////////// //函 數(shù) 名： //功能描述： //函數(shù)說(shuō)明： //調(diào)用函數(shù)： //全局變量： //輸 入： //返 回： //設(shè) 計(jì) 者： //修 改 者： //版 本： ///////////////////////////////////////////////////////////////////// 作為一門(mén)工具，最終的目的就是實(shí)現(xiàn)功能。在滿足這個(gè)前提條件下，我們希望我們的程序能很容易地被別人讀懂，或者能夠很容易地讀懂別人的程序，在團(tuán)體合作開(kāi)發(fā)中就能起到事半功倍之效。在網(wǎng)上請(qǐng)求幫助時(shí)，如能以規(guī)范的寫(xiě)法貼出程序，網(wǎng)友會(huì)比較容易地明白你的問(wèn)題，則會(huì)比較快的得到網(wǎng)友的幫助，否則讓人看上半天也不明所以然，這樣就達(dá)不到預(yù)期的效果了。因此，為了便于源程序的交流，減少合作開(kāi)發(fā)中的障礙，希望大家能夠探討一下C51的編程規(guī)范。把各人認(rèn)為好的建議提出來(lái)，然后做一個(gè)總結(jié)，作為一種大家一致認(rèn)同的規(guī)范，我認(rèn)為將會(huì)是一件很有意義的事。我先提出一些自已的想法，以此拋磚引玉。 一、注釋 1，采用中文； 2，開(kāi)始的注釋： 文件(模塊)注釋內(nèi)容： 公司名稱、版權(quán)、作者名稱、修改時(shí)間、模塊功能、背景介紹等,復(fù)雜的算法需要加上流程說(shuō)明; 比如： /*********************************************************************/ /*公司名稱: */ /*模 塊 名： LCD 模塊 LCD 型號(hào)：HD44780 */ /*創(chuàng) 建 人：zhaojunjie 日期：2001-06-08 */ /*修 改 人： 日期：2001-06-08 */ /*功能描述： */ /*其他說(shuō)明： */ /*版 本： /**********************************************************************/ 函數(shù)開(kāi)頭的注釋內(nèi)容： 函數(shù)名稱、功能、說(shuō)明 輸入、返回、函數(shù)描述、流程處理、全局變量、調(diào)用樣例等,復(fù)雜的函數(shù)需要加上變量用途說(shuō)明; /********************************************************************* * * 函 數(shù) 名: v_LcdInit * 功能描述: LCD初始化 * 函數(shù)說(shuō)明: 初始化命令：0x3c, 0x08, 0x01, 0x06, 0x10, 0x0c * 調(diào)用函數(shù): v_Delaymsec(),v_LcdCmd() * 全局變量: * 輸 入: 無(wú) * 返 回: 無(wú) * 設(shè) 計(jì) 者：zhao 日期：2001-12-09 * 修 改 者：zhao 日期：2001-12-09 * 版 本： ***********************************************************************/ 3、程序中的注釋內(nèi)容： 修改時(shí)間和作者、方便理解的注釋等。注釋內(nèi)容應(yīng)簡(jiǎn)煉、清楚、明了，一目了然的語(yǔ)句不加注釋。 二、命名： 命 |
| 2樓： | >>參與討論 |
| 作者： xzhenggen 于 2006/7/27 17:23:00 發(fā)布：
頂一下,不錯(cuò).收藏先. |
|
| 3樓： | >>參與討論 |
| 作者： sarevok 于 2006/7/27 18:55:00 發(fā)布：
有個(gè)習(xí)慣感覺(jué)不錯(cuò)的 就是判斷相等時(shí)把常數(shù)放在左邊，譬如“1 == a”這樣寫(xiě)，可以避免判斷變成賦值 |
|
| 4樓： | >>參與討論 |
| 作者： jacksnon 于 2006/7/28 16:27:00 發(fā)布：
GOOD |
|
|
|
| 免費(fèi)注冊(cè)為維庫(kù)電子開(kāi)發(fā)網(wǎng)會(huì)員，參與電子工程師社區(qū)討論，點(diǎn)此進(jìn)入 |
Copyright © 1998-2006 m.58mhw.cn 浙ICP證030469號(hào) |