C++文檔結(jié)構(gòu)是怎樣的

這篇文章主要介紹“C++文檔結(jié)構(gòu)是怎樣的”,在日常操作中,相信很多人在C++文檔結(jié)構(gòu)是怎樣的問(wèn)題上存在疑惑,小編查閱了各式資料,整理出簡(jiǎn)單好用的操作方法,希望對(duì)大家解答”C++文檔結(jié)構(gòu)是怎樣的”的疑惑有所幫助!接下來(lái),請(qǐng)跟著小編一起來(lái)學(xué)習(xí)吧!

公司主營(yíng)業(yè)務(wù):網(wǎng)站建設(shè)、網(wǎng)站設(shè)計(jì)、移動(dòng)網(wǎng)站開(kāi)發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳,提高企業(yè)的競(jìng)爭(zhēng)能力。成都創(chuàng)新互聯(lián)是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊(duì)。公司秉承以“開(kāi)放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化,感謝他們對(duì)我們的高要求,感謝他們從不同領(lǐng)域給我們帶來(lái)的挑戰(zhàn),讓我們激情的團(tuán)隊(duì)有機(jī)會(huì)用頭腦與智慧不斷的給客戶帶來(lái)驚喜。成都創(chuàng)新互聯(lián)推出南通免費(fèi)做網(wǎng)站回饋大家。

本文檔的結(jié)構(gòu)

每條規(guī)則(指南,建議)都會(huì)包含幾個(gè)部分:

  • 規(guī)則本身--例如:避免直接使用new運(yùn)算符

  • 規(guī)則的參照編號(hào)--例如,C.7(于類(lèi)相關(guān)的第七條規(guī)則)。由于主要分區(qū)沒(méi)有自然排序,我們使用字母作為規(guī)則參照編號(hào)的第一部分。我們?cè)诰幪?hào)之間留出空隙是希望將增加或者刪除規(guī)則時(shí)的影響降到最低。

  • 原因(根據(jù))-- 程序員很難在沒(méi)有理解規(guī)則的情況下遵守規(guī)則。

    示例 -- 抽象的規(guī)則不容易被理解;示例可能是正面的,也可能是反面的。

  • 可選項(xiàng)--適用于“不要做某事”之類(lèi)的規(guī)則。

  • 例外--我們提供簡(jiǎn)單而普遍的規(guī)則。很多規(guī)則雖然可以廣泛應(yīng)用,但并不是適用于任何情況,因此必須列出例外。

  • 實(shí)施建議--關(guān)于規(guī)則如何被“機(jī)械化”檢查的建議。

  • 注意(注釋?zhuān)?- 無(wú)法歸到其他分類(lèi)卻需要闡述的內(nèi)容。

  • 討論 -- 置于主規(guī)則清單之外的進(jìn)一步展開(kāi)的根據(jù)和/或例子。

某些規(guī)則很難被機(jī)械化檢查,但是它們都符合一個(gè)標(biāo)準(zhǔn):專(zhuān)家程序員可以很容易識(shí)別出違反它們的情況。我們希望“機(jī)械化”工具隨著時(shí)間的推移可以盡量接近專(zhuān)家程序員的水平。同時(shí)我們也認(rèn)為:隨著時(shí)間的推移,規(guī)則會(huì)不斷被完善而變得更加精確和可檢查。

規(guī)則會(huì)盡量簡(jiǎn)單,而不是小心的推敲以照顧到所有的可能和特殊的情況。這類(lèi)信息會(huì)在可選項(xiàng)段落和討論區(qū)記述。如果你沒(méi)有理解某條規(guī)則或者反對(duì)它,請(qǐng)參考討論部分。

這不是一部語(yǔ)言手冊(cè)。它當(dāng)然是有用,但不是包羅萬(wàn)象的,也不保證所有技術(shù)細(xì)節(jié)都正確,也不是現(xiàn)存代碼的指南。推薦的信息源可以查閱參考資料部分。

In.sec: Major sections(主要分區(qū))

  • In: Introduction(介紹)

  • P: Philosophy(基本原則)

  • I: Interfaces(接口)

  • F: Functions(函數(shù))

  • C: Classes and class hierarchies(類(lèi)和繼承)

  • Enum: Enumerations(枚舉)

  • R: Resource management(資源管理)

  • ES: Expressions and statements(表達(dá)式和陳述)

  • Per: Performance(性能)

  • CP: Concurrency and parallelism(并發(fā)和相似性)

  • E: Error handling(錯(cuò)誤處理)

  • Con: Constants and immutability(常量和不變性)

  • T: Templates and generic programming(模板和泛型編程)

  • CPL: C-style programming(C風(fēng)格編程)

  • SF: Source files(源代碼)

  • SL: The Standard Library(標(biāo)準(zhǔn)庫(kù))

Supporting sections:

  • A: Architectural ideas(結(jié)構(gòu)方面的想法)

  • NR: Non-Rules and myths(偽規(guī)則和傳言)

  • RF: References(參考資料)

  • Pro: Profiles(規(guī)則側(cè)面)

  • GSL: Guidelines support library(指南支持庫(kù))

  • NL: Naming and layout rules(命名和布局規(guī)則)

  • FAQ: Answers to frequently asked questions(常見(jiàn)問(wèn)題回答)

  • Appendix A: Libraries(庫(kù))

  • Appendix B: Modernizing code(現(xiàn)代化代碼)

  • Appendix C: Discussion(討論)

  • Appendix D: Supporting tools(支持工具)

  • Glossary(術(shù)語(yǔ)表)

  • To-do: Unclassified proto-rules(未完事項(xiàng):未分類(lèi)規(guī)則原型)

各個(gè)分區(qū)之間并非正交關(guān)系。

譯者注:有可能存在重復(fù)

每個(gè)分區(qū)(例如:P代表基本原則)和每個(gè)子分區(qū)(例如,C.hier代表面向?qū)ο缶幊蹋∣OP)中的類(lèi)層次關(guān)系)都有一個(gè)縮略語(yǔ)以便檢索和參照。主分區(qū)的縮略語(yǔ)也用于規(guī)則編碼(例如,“C11”代表“讓具象類(lèi)型有規(guī)律”)

到此,關(guān)于“C++文檔結(jié)構(gòu)是怎樣的”的學(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí),請(qǐng)繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編會(huì)繼續(xù)努力為大家?guī)?lái)更多實(shí)用的文章!

網(wǎng)頁(yè)標(biāo)題:C++文檔結(jié)構(gòu)是怎樣的
瀏覽路徑:http://muchs.cn/article8/gheoop.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供營(yíng)銷(xiāo)型網(wǎng)站建設(shè)、外貿(mào)網(wǎng)站建設(shè)、全網(wǎng)營(yíng)銷(xiāo)推廣、品牌網(wǎng)站建設(shè)、微信公眾號(hào)App設(shè)計(jì)

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)

成都app開(kāi)發(fā)公司