主頁 >  其他 > 優秀的編程習慣——C語言代碼規范(編程規范)

優秀的編程習慣——C語言代碼規范(編程規范)

2020-12-04 10:55:43 其他

C語言代碼規范(編程規范)

什么叫規范?在C語言中不遵守編譯器的規定,編譯器在編譯時就會報錯,這個規定叫作規則,但是有一種規定,它是一種人為的、約定成俗的,即使不按照那種規定也不會出錯,這種規定就叫作規范,

雖然我們不按照規范也不會出錯,但是那樣代碼寫得就會很亂,大家剛開始學習C語言的時候,第一步不是說要把程式寫正確,而是要寫規范,因為如果你養成一種非常不好的寫代碼的習慣,代碼就會寫得亂七八糟,等到將來作業面試的時候,這樣的習慣可能會讓你失去機會,
代碼如何寫才能規范
那么代碼如何寫才能寫得很規范呢?代碼的規范化不是說看完本節內容后就能實作的,它里面細節很多,而且需要不停地寫代碼練習,不停地領悟,慢慢地才能掌握的一種編程習慣,所以大家不要想著一下子就能把代碼規范化的所有知識全部掌握,也不要想著一下子就能把代碼寫規范,這是不太可能的,

有很多知識,比如為什么代碼要這樣寫,為什么不能那樣寫,作為一個初學者你是很難弄明白的,有很多規范是為了在程式代碼量很大的時候,便于自己閱讀,也便于別人閱讀,

所以剛開始的時候有很多規范你不知道為什么要那樣規定,你就單純地模仿就行了,等將來敲代碼敲得時間長了,你就會感覺到那樣寫是很有好處的,
代碼規范化的好處
代碼規范化的第一個好處就是看著很整齊、很舒服,假如你現在用不規范的方式寫了一萬行代碼,現在能看得懂,但等過了三個月你再回頭看時就很吃力了,更不要說給別人看了,所以代碼要寫規范,比如加注釋就是代碼規范化的一個思想,

在一般情況下,根據軟體工程的思想,我們的注釋要占整個檔案的20%以上,所以注釋要寫得很詳細,而且格式要寫得很規范,

第二個好處是,把代碼寫規范則程式不容易出錯,如果按照不規范的格式輸入代碼的話,很容易出錯,而代碼寫規范的話即使出錯了查錯也會很方便,格式雖然不會影響程式的功能,但會影響可讀性,程式的格式追求清晰、美觀,是程式風格的重要構成元素,
代碼規范化的七大原則
代碼規范化基本上有七大原則,體現在空行、空格、成對書寫、縮進、對齊、代碼行、注釋七方面的書寫規范上,

  1. 空行
    空行起著分隔程式段落的作用,空行得體將使程式的布局更加清晰,空行不會浪費記憶體,雖然列印含有空行的程式會多消耗一些紙張,但是值得,

規則一:定義變數后要空行,盡可能在定義變數的同時初始化該變數,即遵循就近原則,如果變數的參考和定義相隔比較遠,那么變數的初始化就很容易被忘記,若參考了未被初始化的變數,就會導致程式出錯,

規則二:每個函式定義結束之后都要加空行,

總規則:兩個相對獨立的程式塊、變數說明之后必須要加空行,比如上面幾行代碼完成的是一個功能,下面幾行代碼完成的是另一個功能,那么它們中間就要加空行,這樣看起來更清晰,
2) 空格
規則一:關鍵字之后要留空格,像 const、case 等關鍵字之后至少要留一個空格,否則無法辨析關鍵字,像 if、for、while 等關鍵字之后應留一個空格再跟左括號(,以突出關鍵字,

規則二:函式名之后不要留空格,應緊跟左括號(,以與關鍵字區別,

規則三:(向后緊跟;)、,、;這三個向前緊跟;緊跟處不留空格,

規則四:,之后要留空格,如果;不是一行的結束符號,其后要留空格,

規則五:賦值運算子、關系運算子、算術運算子、邏輯運算子、位運算子,如 =、==、!=、+=、-=、*=、/=、%=、>>=、<<=、&=、=、|=、>、<=、>、>=、+、-、*、/、%、&、|、&&、||、<<、>>、 等雙目運算子的前后應當加空格,

注意,運算子“%”是求余運算子,與 printf 中 %d 的“%”不同,所以 %d 中的“%”前后不用加空格,

規則六:單目運算子 !、~、++、--、-、*、& 等前后不加空格,

注意:
這里的“-”和規則五里面的“-”不同,這里的“-”是負號運算子,規則五里面的“-”是減法運算子,
這里的“”和規則五里面的“”也不同,這里的“”是指標運算子,規則五里面的“”是乘法運算子,
這里的“&”和規則五里面的“&”也不同,這里的“&”是取地址運算子,規則五里面的“&”是按位與運算子,

總之,規則六中的是單目運算子,而規則五中的是雙目運算子,它們是不一樣的,

規則七:像陣列符號[]、結構體成員運算子.、指向結構體成員運算子->,這類運算子前后不加空格,

規則八:對于運算式比較長的 for 陳述句和 if 陳述句,為了緊湊起見,可以適當地去掉一些空格,但 for 和 if 后面緊跟的空格不可以刪,其后面的陳述句可以根據陳述句的長度適當地去掉一些空格,例如:
for (i=0; i<10; i++)

for 和分號后面保留空格就可以了,=和<前后的空格可去掉,
3) 成對書寫
成對的符號一定要成對書寫,如 ()、{},不要寫完左括號然后寫內容最后再補右括號,這樣很容易漏掉右括號,尤其是寫嵌套程式的時候,
4) 縮進
縮進是通過鍵盤上的 Tab 鍵實作的,縮進可以使程式更有層次感,原則是:如果地位相等,則不需要縮進;如果屬于某一個代碼的內部代碼就需要縮進,
5) 對齊
對齊主要是針對大括號{}說的:

規則一:{和}分別都要獨占一行,互為一對的{和}要位于同一列,并且與參考它們的陳述句左對齊,

規則二:{}之內的代碼要向內縮進一個 Tab,且同一地位的要左對齊,地位不同的繼續縮進,

還有需要注意的是,很多編程軟體是會“自動對齊”的,比如:

#include <stdio.h>
int main(void)
{
    if ()
    return 0;
}

寫完 if 那一行后,按回車,此時游標在括號的右邊,而此 if 下的大括號要寫在與 if 左對齊的正下方,通常我們是按一下 Backspace 鍵使游標停在與 if 左對齊的正下方,但事實上我們不需要這樣做,我們直接輸入大括號即可,系統會自動對齊到與 if 左對齊的正下方,再接著看:

#include <stdio.h>
int main(void)
{
    if ()
    {
        while ()
    }
    return 0;
}

寫完 while 那一行后,按回車,此時游標不是停在與 while 左對齊的正下方,同樣,我們不需要按 Backspace,直接輸入大括號即可,系統會自動對齊到與 while 左對齊的正下方的,

此外編程軟體還有“對齊、縮進修正”功能,就是按 Ctrl+A 全選,然后按 Alt+F8,這時程式中所有成對的大括號都會自動對齊,未縮進的也會自動縮進,不管是在編程程序中,還是在撰寫結束完之后,都可以使用這個技巧,但如果完全按照規范寫,那根本就不需要這個技巧,所以,這只是一個輔助功能,
6) 代碼行
規則一:一行代碼只做一件事情,如只定義一個變數,或只寫一條陳述句,這樣的代碼容易閱讀,并且便于寫注釋,

規則二:if、else、for、while、do 等陳述句自占一行,執行陳述句不得緊跟其后,此外,非常重要的一點是,不論執行陳述句有多少行,就算只有一行也要加{},并且遵循對齊的原則,這樣可以防止書寫失誤,
7) 注釋
C語言中一行注釋一般采用//…,多行注釋必須采用//,注釋通常用于重要的代碼行或段落提示,在一般情況下,源程式有效注釋量必須在 20% 以上,雖然注釋有助于理解代碼,但注意不可過多地使用注釋,

規則一:注釋是對代碼的“提示”,而不是檔案,程式中的注釋不可喧賓奪主,注釋太多會讓人眼花繚亂,

規則二:如果代碼本來就是清楚的,則不必加注釋,例如:

i++;  //i加1

這個就是多余的注釋,

規則三:邊寫代碼邊注釋,修改代碼的同時要修改相應的注釋,以保證注釋與代碼的一致性,不再有用的注釋要洗掉,

規則四:當代碼比較長,特別是有多重嵌套的時候,應當在段落的結束處加注釋,這樣便于閱讀,

規則五:每一條宏定義的右邊必須要有注釋,說明其作用,
實際案例
下面我們給出一段求一元二次方程的代碼,讓大家實際感受一下,雖然這個程式不包含所有的規范,但一些包含的規范我們可以對照著看看,

以下程式的功能是把任何一個一元二次方程 ax2+bx+c=0 的解給求出來,

# include <stdio.h>
# include <math.h> /*因為要用到求平方函式sqrt(),所以要包含頭檔案 math.h*/
int main(void)
{
    //把三個系數保存到計算機中
    int a = 1;  // “=”不表示相等,而是表示賦值
    int b = 2;
    int c = 1;
    double delta;   //delta存放的是b*b - 4*a*c的值
    double x1, x2;  //分別用于存放一元二次方程的兩個解
    delta = b*b - 4*a*c;
    if (delta > 0)
    {
        x1 = (-b + sqrt(delta)) / (2*a);
        x2 = (-b - sqrt(delta)) / (2*a);
        printf("該一元二次方程有兩個解,x1 = %f, x2 = %f\n", x1, x2);
    }
    else if (0 == delta)
    {
        x1 = (-b) / (2*a);
        x2 = x1;  //左邊值賦給右邊
        printf("該一元二次方程有一個唯一解,x1 = x2 = %f\n", x1);
    }
    else
    {
        printf("無解\n");
    }
    return 0;
}

運行結果:
該一元二次方程有一個唯一解,x1 = x2 = -1.000000

大家不用關心程式的邏輯和思路,只關注代碼規范即可,
小結
單純地讀完一遍肯定沒什么感覺,沒關系,要想把代碼寫規范不是一朝一夕的事,這應該是一種習慣,需要不停地敲、不停的積累,剛開始的時候多模仿,照著規范寫就行了,以后在寫代碼的時候,情不自禁地就會按規范的方式書寫了,

轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/229804.html

標籤:其他

上一篇:Maven子專案無法添加父類專案的依賴

下一篇:每日一題之rot13 與base64編碼

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 網閘典型架構簡述

    網閘架構一般分為兩種:三主機的三系統架構網閘和雙主機的2+1架構網閘。 三主機架構分別為內端機、外端機和仲裁機。三機無論從軟體和硬體上均各自獨立。首先從硬體上來看,三機都用各自獨立的主板、記憶體及存盤設備。從軟體上來看,三機有各自獨立的作業系統。這樣能達到完全的三機獨立。對于“2+1”系統,“2”分為 ......

    uj5u.com 2020-09-10 02:00:44 more
  • 如何從xshell上傳檔案到centos linux虛擬機里

    如何從xshell上傳檔案到centos linux虛擬機里及:虛擬機CentOs下執行 yum -y install lrzsz命令,出現錯誤:鏡像無法找到軟體包 前言 一、安裝lrzsz步驟 二、上傳檔案 三、遇到的問題及解決方案 總結 前言 提示:其實很簡單,往虛擬機上安裝一個上傳檔案的工具 ......

    uj5u.com 2020-09-10 02:00:47 more
  • 一、SQLMAP入門

    一、SQLMAP入門 1、判斷是否存在注入 sqlmap.py -u 網址/id=1 id=1不可缺少。當注入點后面的引數大于兩個時。需要加雙引號, sqlmap.py -u "網址/id=1&uid=1" 2、判斷文本中的請求是否存在注入 從文本中加載http請求,SQLMAP可以從一個文本檔案中 ......

    uj5u.com 2020-09-10 02:00:50 more
  • Metasploit 簡單使用教程

    metasploit 簡單使用教程 浩先生, 2020-08-28 16:18:25 分類專欄: kail 網路安全 linux 文章標簽: linux資訊安全 編輯 著作權 metasploit 使用教程 前言 一、Metasploit是什么? 二、準備作業 三、具體步驟 前言 Msfconsole ......

    uj5u.com 2020-09-10 02:00:53 more
  • 游戲逆向之驅動層與用戶層通訊

    驅動層代碼: #pragma once #include <ntifs.h> #define add_code CTL_CODE(FILE_DEVICE_UNKNOWN,0x800,METHOD_BUFFERED,FILE_ANY_ACCESS) /* 更多游戲逆向視頻www.yxfzedu.com ......

    uj5u.com 2020-09-10 02:00:56 more
  • 北斗電力時鐘(北斗授時服務器)讓網路資料更精準

    北斗電力時鐘(北斗授時服務器)讓網路資料更精準 北斗電力時鐘(北斗授時服務器)讓網路資料更精準 京準電子科技官微——ahjzsz 近幾年,資訊技術的得了快速發展,互聯網在逐漸普及,其在人們生活和生產中都得到了廣泛應用,并且取得了不錯的應用效果。計算機網路資訊在電力系統中的應用,一方面使電力系統的運行 ......

    uj5u.com 2020-09-10 02:01:03 more
  • 【CTF】CTFHub 技能樹 彩蛋 writeup

    ?碎碎念 CTFHub:https://www.ctfhub.com/ 筆者入門CTF時時剛開始刷的是bugku的舊平臺,后來才有了CTFHub。 感覺不論是網頁UI設計,還是題目質量,賽事跟蹤,工具軟體都做得很不錯。 而且因為獨到的金幣制度的確讓人有一種想去刷題賺金幣的感覺。 個人還是非常喜歡這個 ......

    uj5u.com 2020-09-10 02:04:05 more
  • 02windows基礎操作

    我學到了一下幾點 Windows系統目錄結構與滲透的作用 常見Windows的服務詳解 Windows埠詳解 常用的Windows注冊表詳解 hacker DOS命令詳解(net user / type /md /rd/ dir /cd /net use copy、批處理 等) 利用dos命令制作 ......

    uj5u.com 2020-09-10 02:04:18 more
  • 03.Linux基礎操作

    我學到了以下幾點 01Linux系統介紹02系統安裝,密碼啊破解03Linux常用命令04LAMP 01LINUX windows: win03 8 12 16 19 配置不繁瑣 Linux:redhat,centos(紅帽社區版),Ubuntu server,suse unix:金融機構,證券,銀 ......

    uj5u.com 2020-09-10 02:04:30 more
  • 05HTML

    01HTML介紹 02頭部標簽講解03基礎標簽講解04表單標簽講解 HTML前段語言 js1.了解代碼2.根據代碼 懂得挖掘漏洞 (POST注入/XSS漏洞上傳)3.黑帽seo 白帽seo 客戶網站被黑帽植入劫持代碼如何處理4.熟悉html表單 <html><head><title>TDK標題,描述 ......

    uj5u.com 2020-09-10 02:04:36 more
最新发布
  • 2023年最新微信小程式抓包教程

    01 開門見山 隔一個月發一篇文章,不過分。 首先回顧一下《微信系結手機號資料庫被脫庫事件》,我也是第一時間得知了這個訊息,然后跟蹤了整件事情的經過。下面是這起事件的相關截圖以及近日流出的一萬條資料樣本: 個人認為這件事也沒什么,還不如關注一下之前45億快遞資料查詢渠道疑似在近日復活的訊息。 訊息是 ......

    uj5u.com 2023-04-20 08:48:24 more
  • web3 產品介紹:metamask 錢包 使用最多的瀏覽器插件錢包

    Metamask錢包是一種基于區塊鏈技術的數字貨幣錢包,它允許用戶在安全、便捷的環境下管理自己的加密資產。Metamask錢包是以太坊生態系統中最流行的錢包之一,它具有易于使用、安全性高和功能強大等優點。 本文將詳細介紹Metamask錢包的功能和使用方法。 一、 Metamask錢包的功能 數字資 ......

    uj5u.com 2023-04-20 08:47:46 more
  • vulnhub_Earth

    前言 靶機地址->>>vulnhub_Earth 攻擊機ip:192.168.20.121 靶機ip:192.168.20.122 參考文章 https://www.cnblogs.com/Jing-X/archive/2022/04/03/16097695.html https://www.cnb ......

    uj5u.com 2023-04-20 07:46:20 more
  • 從4k到42k,軟體測驗工程師的漲薪史,給我看哭了

    清明節一過,盲猜大家已經無心上班,在數著日子準備過五一,但一想到銀行卡里的余額……瞬間心情就不美麗了。最近,2023年高校畢業生就業調查顯示,本科畢業月平均起薪為5825元。調查一出,便有很多同學表示自己又被平均了。看著這一資料,不免讓人想到前不久中國青年報的一項調查:近六成大學生認為畢業10年內會 ......

    uj5u.com 2023-04-20 07:44:00 more
  • 最新版本 Stable Diffusion 開源 AI 繪畫工具之中文自動提詞篇

    🎈 標簽生成器 由于輸入正向提示詞 prompt 和反向提示詞 negative prompt 都是使用英文,所以對學習母語的我們非常不友好 使用網址:https://tinygeeker.github.io/p/ai-prompt-generator 這個網址是為了讓大家在使用 AI 繪畫的時候 ......

    uj5u.com 2023-04-20 07:43:36 more
  • 漫談前端自動化測驗演進之路及測驗工具分析

    隨著前端技術的不斷發展和應用程式的日益復雜,前端自動化測驗也在不斷演進。隨著 Web 應用程式變得越來越復雜,自動化測驗的需求也越來越高。如今,自動化測驗已經成為 Web 應用程式開發程序中不可或缺的一部分,它們可以幫助開發人員更快地發現和修復錯誤,提高應用程式的性能和可靠性。 ......

    uj5u.com 2023-04-20 07:43:16 more
  • CANN開發實踐:4個DVPP記憶體問題的典型案例解讀

    摘要:由于DVPP媒體資料處理功能對存放輸入、輸出資料的記憶體有更高的要求(例如,記憶體首地址128位元組對齊),因此需呼叫專用的記憶體申請介面,那么本期就分享幾個關于DVPP記憶體問題的典型案例,并給出原因分析及解決方法。 本文分享自華為云社區《FAQ_DVPP記憶體問題案例》,作者:昇騰CANN。 DVPP ......

    uj5u.com 2023-04-20 07:43:03 more
  • msf學習

    msf學習 以kali自帶的msf為例 一、msf核心模塊與功能 msf模塊都放在/usr/share/metasploit-framework/modules目錄下 1、auxiliary 輔助模塊,輔助滲透(埠掃描、登錄密碼爆破、漏洞驗證等) 2、encoders 編碼器模塊,主要包含各種編碼 ......

    uj5u.com 2023-04-20 07:42:59 more
  • Halcon軟體安裝與界面簡介

    1. 下載Halcon17版本到到本地 2. 雙擊安裝包后 3. 步驟如下 1.2 Halcon軟體安裝 界面分為四大塊 1. Halcon的五個助手 1) 影像采集助手:與相機連接,設定相機引數,采集影像 2) 標定助手:九點標定或是其它的標定,生成標定檔案及內參外參,可以將像素單位轉換為長度單位 ......

    uj5u.com 2023-04-20 07:42:17 more
  • 在MacOS下使用Unity3D開發游戲

    第一次發博客,先發一下我的游戲開發環境吧。 去年2月份買了一臺MacBookPro2021 M1pro(以下簡稱mbp),這一年來一直在用mbp開發游戲。我大致分享一下我的開發工具以及使用體驗。 1、Unity 官網鏈接: https://unity.cn/releases 我一般使用的Apple ......

    uj5u.com 2023-04-20 07:40:19 more