Windows客户端C/C++编程规范“建议”——前言
前言
? ? ? ? 工作中接觸了很多編程規(guī)范。其中最有意思的是,公司最近發(fā)布了一版C/C++編程規(guī)范,然后我看到該規(guī)范的最后一段時(shí),有這么一句:“該規(guī)范不適用于Windows平臺(tái)開(kāi)發(fā)”。看來(lái)這份規(guī)范是由做其他平臺(tái)開(kāi)發(fā)的同學(xué)制定的。那么做Windows開(kāi)發(fā)的人都去哪兒了?后來(lái)由于工作需要,項(xiàng)目組需要我制定一份編程規(guī)范。這也是我這系列博客的由來(lái)。(轉(zhuǎn)載請(qǐng)指明出于breaksoftware的csdn博客)
? ? ? ? 說(shuō)到“規(guī)范“”,可能沒(méi)多少人喜歡這樣的東西。相信很多工程師和我一樣,都喜歡互聯(lián)網(wǎng)的一些特質(zhì):自由、兼容并包。己所不欲勿施于人,所以我制定該“規(guī)范”時(shí),也是抱著開(kāi)放的態(tài)度——在”規(guī)范“之后加了”建議“二字。之后,我都會(huì)統(tǒng)稱這些條例為“建議”。
? ? ? ? 假如說(shuō)指定“規(guī)范”是容易的(其實(shí)也不容易),那么最難的是讓人遵從。一般如果我們想遵從什么,肯定要先想好我們?yōu)槭裁匆駨?#xff0c;我們遵從之有什么好處,可以給我們帶來(lái)什么?同樣我也是按著這個(gè)思維去制定這樣的“建議”,我將會(huì)從代碼的可讀性、可維護(hù)性、健壯性等角度,思考和編制該“建議”。希望這些“建議”可以協(xié)助大家寫(xiě)出更易讀、更健壯、更好看的代碼。
? ? ? ? 本“建議”條例分為以下若干等級(jí):
| 【必須】 | 編碼必須遵從。 |
| 【要求】 | 該規(guī)則可以非常好的提高易讀性、高效性和安全性。在特殊情況下,可以不遵從,但是需要給出不遵從的理由。 |
| 【推薦】 | 該規(guī)則可以部分提高易讀性、高效性和安全性。在大部分情況下,需要遵從。 |
| 【建議】 | 該規(guī)則只是作為建議,代碼作者可以根據(jù)自己判斷來(lái)決定。 |
? ? ? ? 本“建議”中例子代碼,使用不同底色表示代碼是否存在問(wèn)題:
? ? ? ? 表示代碼存在問(wèn)題。
? ? ? ? 表示一種可以修復(fù)存在問(wèn)題代碼的方式。
?? ? ? ?本建議將分為以下若干模塊。我會(huì)根據(jù)工作中新的發(fā)現(xiàn)和認(rèn)識(shí)以及朋友們的建議,不定期更新這些條例。并將更新歷史記錄在該文的末尾,以便大家查閱。
? ? ? ? 模塊:
- 函數(shù) ? ? ? ? ? ? ? ? ? ? 《Windows客戶端C/C++編程規(guī)范“建議”——函數(shù)》
- 指針 ? ? ? ? ? ? ? ? ? ? 《Windows客戶端C/C++編程規(guī)范“建議”——指針》?
- 函數(shù)調(diào)用 ? ? ? ? ? ? 《Windows客戶端C/C++編程規(guī)范“建議”——函數(shù)調(diào)用》
- 表達(dá)式和運(yùn)算 ? ? 《Windows客戶端C/C++編程規(guī)范“建議”——表達(dá)式和運(yùn)算》
- 結(jié)構(gòu) ? ? ? ? ? ? ? ? ? ? 《Windows客戶端C/C++編程規(guī)范“建議”——結(jié)構(gòu)》
- 宏 ? ? ? ? ? ? ? ? ? ? ? ??《Windows客戶端C/C++編程規(guī)范“建議”——宏》
- 文件 ? ? ? ? ? ? ? ? ? ??《Windows客戶端C/C++編程規(guī)范“建議”——文件》
- 變量和常量 ? ? ? ??《Windows客戶端C/C++編程規(guī)范“建議”——變量和常量》
- 風(fēng)格 ? ? ? ? ? ? ? ? ? ??《Windows客戶端C/C++編程規(guī)范“建議”——風(fēng)格》
? ? ? ? 更新歷史:
| 時(shí)間 | 內(nèi)容 | 備注 |
| 2014.07.18 | 錄入“建議”各項(xiàng) | 初稿 |
總結(jié)
以上是生活随笔為你收集整理的Windows客户端C/C++编程规范“建议”——前言的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 一种使用GDI+对图片尺寸和质量的压缩方
- 下一篇: Windows客户端C/C++编程规范“