程式設計命名規範以及函式檔案注釋

2021-10-22 14:06:27 字數 1731 閱讀 6277

1.2. 匈牙利命名法

1.3 下劃線命名法

1.4. 命名例項

2 函式注釋

3 檔案注釋

除第乙個單詞之外,其他單詞首字母大寫(常用於變數)

int mystudentnumber
與小駝峰式命名法的最大區別在於,每個單詞的第乙個字母都要大寫。(常用於類名,函式名,屬性,命名空間)

class

studentfamily

變數名=屬性+型別+物件描述,這樣做的好處是使程式設計師第一眼看到變數時就對變數的型別和其它屬性有直觀的了解。

全域性變數 g_

常量 c_

成員變數 m_

靜態變數 s_

a      陣列(array)

b 布林值(boolean)

by 位元組(byte)

c 有符號字元(char)

cb 無符號字元(char byte,並沒有神馬人用的)

cr 顏色參考值(color ref)

cx,cy 座標差(長度 short int)

dw 雙字(double word)

fn 函式(function)

h handle(控制代碼)

i 整形(int)

l 長整型(long int)

lp 長指標(long pointer)

m_ 類成員(class member)

n 短整型(short int)

np 近程指標(near pointer)

p 指標(pointer)

s 字串(string)

sz 以 null 做結尾的字串型(string with zero end)

w 字(word)

最大 max

最小 min

初始化 init

臨時變數 t(或temp)

源物件 src

目的物件 dest

所有字母均小寫,每個單詞間以下劃線分割

int student_number
m_imydata 是乙個匈牙利命名法,m_表示它是成員變數,小寫的i說明了它是個整型,後面的和帕斯卡命名相同,指示了該變數的用途

mydata 是乙個駱駝命名法,它第乙個單詞的第乙個字母小寫,後面的單詞首字母大寫,看起來像乙個駱駝

mydata 就是乙個帕斯卡命名的示例

my_data 是乙個下劃線命名的示例

/**************************/

//功能

//引數

//返回值

//主要思想

//呼叫

//日期

/*************************/

/***************************/

//工程:檔案所在工程

//描述:主要功能

//主要函式:

//版本/日期

/**************************/

參考:

程式設計規範學習 1 注釋和命名

既然準備好好的弄,就先把程式設計規範給學習下,先看華為的規範,從簡單的檔案注釋和命名開始,這2塊是最容易搞亂的,還是得堅持住,天天看,每次程式設計看一次,就不信還搞不定,下面摘下大概的規範內容,有部分修改了點。注釋規範 檔案注釋 file name 檔名 description 用於詳細說明此程式檔...

程式設計命名規範之 Google C 程式設計命名規範

大一的時候曾經特別關注過命名規範的問題,並且寫了乙個部落格總結了一些基礎的規範 三種程式設計命名規範 後來得知有一種命名規範叫做 go ogle c goo glec 命名規範的時候,特意看了一下,但是特別反感,感覺太糟糕了,所以就沒有深究過 我討厭壓行,這是我反感這個規範的最大原因。不過,現在我不...

python 增加檔案注釋以及函式注釋

毋庸置疑,良好的編碼習慣對於學習一門語言很重要,這樣可以很好的保持 可讀性以及可維護性。的可讀性可以通過 的命名以及注釋體現。當然理想的可讀性良好的 是完全沒有注釋,本身已經具有充分的自明性。目前對於python遵守的pep8 規範,需要進一步的了解和熟悉。首先掌握檔案注釋以及函式注釋。1.檔案注釋...