• <ins id="pjuwb"></ins>
    <blockquote id="pjuwb"><pre id="pjuwb"></pre></blockquote>
    <noscript id="pjuwb"></noscript>
          <sup id="pjuwb"><pre id="pjuwb"></pre></sup>
            <dd id="pjuwb"></dd>
            <abbr id="pjuwb"></abbr>

            那誰的技術(shù)博客

            感興趣領(lǐng)域:高性能服務(wù)器編程,存儲,算法,Linux內(nèi)核
            隨筆 - 210, 文章 - 0, 評論 - 1183, 引用 - 0
            數(shù)據(jù)加載中……

            CGL編碼規(guī)范V1.0

            之前雖然在寫代碼的時候自己心中有一個編碼的規(guī)范,但是畢竟沒有述之文字,現(xiàn)在回頭看了看發(fā)現(xiàn)還是有很多地方不夠規(guī)范的,花了一個晚上掃了一下原有的代碼,制定出這個規(guī)范,畢竟是寫出來白紙黑字的,以后有依可循,這并不是最后的規(guī)范版本,我把它命名為V1.0,會根據(jù)需要不斷的補充完善,并且會check in到SF的SVN中去,有可能的話再寫一份E文版的規(guī)范,而每次對規(guī)范的補充完善相應(yīng)的都會進行對代碼的重構(gòu)。

            這是一個好的習慣,希望我以后不管是作商業(yè)上的開發(fā)還是自己下面作著玩兒寫的代碼都按照這些流程走下來,我相信,好的習慣和風格會帶來很多積極的影響。

             

            CGL編碼命名規(guī)范V1.0(2007-04-29)

            1.變量命名采用匈牙利命名法,如下:
            1)整型變量加前綴n
            2)指針變量加前綴p
            3)自定義也就是typedef聲明的新類型變量加前綴t,而這些類型的定義后面加_t后綴,如iter_t
            4)char類型加前綴c,char數(shù)組加類型sz
            5)變量的命名一般為以上的前綴加上相應(yīng)的描述名詞,同時名詞第一個字母大寫,如piterator_t pIter

            2.宏一律大寫,并且加上前綴CGL_

            3.函數(shù)名稱加前綴cgl_,如果是某類型的接口函數(shù)加上類型名稱,其后命名基本參照對應(yīng)的STL中函數(shù)的命名,
                如cgl_list_clear與STL中l(wèi)ist容器的clear函數(shù)對應(yīng)
                但是還需要注意的是,如果是在某個文件中的static函數(shù),也就是外部不能使用的函數(shù),前綴改為cgls_
                而對于某個結(jié)構(gòu)體內(nèi)定義的函數(shù)指針類型不需要加上cgl前綴,只需要對函數(shù)功能進行說明就可以了,一般為
                動詞
            +名詞的形式命名。
                如iterator中的函數(shù)指針    data_t                    (
            *get_value)(piterator_t pIter);就是得到這個iterator
                值的函數(shù)。
                
                有了這個規(guī)則,那些在CGL中出現(xiàn)的沒有這些前綴的函數(shù)都是C庫中提供的庫函數(shù)。
                
            4.進行比較操作時把常量放在比較操作符左邊,如if(NULL != pIter)

            5.自定義的數(shù)據(jù)類型以及結(jié)構(gòu)體的命名習慣為描述該類型的名詞 + "_t",如iterator_t,如果是指向該類型
              變量的指針類型則在前面加上p前綴,如piterator_t
              
            6.頭文件中為防止重復(fù)包含所聲明的宏命名規(guī)范為該頭文件的去掉".h"后綴之后的文件名再加上"_H"后綴,
                同時這個組合的前后都要加上
            "__",如cgl_commondef.h頭文件中的宏為__CGL_COMMONDEF_H__
                
            7.每個文件都要以“CGL_BEGIN”開始,以“CGL_END”結(jié)尾

            8.不可忽略編譯時的警告信息,如果在操作中需要強制轉(zhuǎn)換的要明確寫出來,不應(yīng)依賴于編譯器隱式的轉(zhuǎn)換。

            9.文件的命名為cgl_前綴加上該文件的描述,一般的,這個后綴與STL中對應(yīng)的文件名相同,如STL中的list文件
              其在CGL中的對應(yīng)頭文件就是cgl_list.h,c文件就是cgl_list.c
              
            10.所有函數(shù)的定義前面一律加上對函數(shù)功能,輸入,輸出參數(shù)的注釋說明  


              
             




             

            posted on 2007-04-28 23:48 那誰 閱讀(1083) 評論(1)  編輯 收藏 引用 所屬分類: CGL

            評論

            # re: CGL編碼規(guī)范V1.0  回復(fù)  更多評論   

            文檔建議考慮用 Doxygen
            http://www.stack.nl/~dimitri/doxygen/
            2007-04-29 03:57 | 8pm
            亚洲精品午夜国产va久久| 久久久久久免费视频| 色偷偷偷久久伊人大杳蕉| 99国产精品久久久久久久成人热| 一本一道久久精品综合| 亚洲精品美女久久久久99| 日韩久久久久中文字幕人妻| 熟妇人妻久久中文字幕| 国产欧美一区二区久久| 欧美亚洲色综久久精品国产| 国产精品久久波多野结衣| 亚洲v国产v天堂a无码久久| 亚洲AV无码成人网站久久精品大| 日本免费久久久久久久网站| 国产婷婷成人久久Av免费高清| 久久久久青草线蕉综合超碰| 久久久久久亚洲精品无码| 97久久精品无码一区二区天美| 国产AV影片久久久久久| 国产精品久久久久一区二区三区| 久久综合久久美利坚合众国| 久久这里有精品视频| 久久亚洲国产精品123区| 国产精品女同久久久久电影院| 日韩久久无码免费毛片软件| 久久精品国产清高在天天线| 久久精品国产精品亚洲精品| 久久人人爽人人人人爽AV| 久久人人爽人人爽人人片AV东京热 | 亚洲国产精品无码久久一线| 久久久受www免费人成| 亚洲伊人久久大香线蕉苏妲己| 人妻少妇久久中文字幕一区二区| 久久99国产精品久久99小说| 国产精品热久久毛片| 国产高清美女一级a毛片久久w| 2020久久精品国产免费| 精品久久久久久无码专区 | 精品久久久久中文字幕日本| 亚洲精品无码久久久久sm| 久久狠狠爱亚洲综合影院|