C 注釋的應用

2021-09-25 15:15:18 字數 1507 閱讀 6266

注釋是為了讓別人能更快的看懂你的**的最快路徑。

一、注釋約定

1.類注釋

///

///使用者資訊

///public

class

userinfor

2.類屬性注釋

///

///使用者id

///public

intuserid

3.方法注釋

///

///使用者登入

//////username

">

使用者名稱///

password

">

密碼///

返回資料結果

public

actionresult

userregister

(string

username,

string

password)

4.**間注釋

①單行注釋:注釋行數<3行時使用

//單行注釋

②多行注釋:2《注釋行數<=10行時使用

/*多行注釋1

多行注釋2

多行注釋3*/

③注釋塊:10《注釋行數時使用, 用n個*

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

***塊注釋1

***塊注釋2

*......

***塊注釋11

***塊注釋12

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

5.對意料之中的疑問新增注釋

當別人讀你的**的時候,有些部分可能讓他們有這樣的疑問:「為什麼要這樣寫」你的工作就要給這些部分新增注釋

//定義刪除方法

public

void

deletefile(

string

strpicturename)

if(strpicturename!=

string

.empty || strpicturename !=

null)

}二、命名規範

我們在命名識別符號時(包括引數,常量,變數),應使用單詞的首字母大小寫來區分乙個識別符號中的多個單詞,如username.

pascalcasing

pascalcasing包含一到多個單詞,每乙個單詞第乙個字母大寫,其餘字母均小寫,例如:helloworld、username等。除了引數、變數、常量外,所有的命名空間名稱、類、函式、介面、屬性、事件、列舉等名稱的 命名,使用pascal風格。

3.camelcasing

camelcasing

包含一到多個單詞,第乙個單詞首字母小寫,其餘單詞首字母大寫。例如:userid、studentname等,。引數與變數的命名使用

camelcasing

4.私有變數的命名

private 的私有變數使用下劃線"_

"+camelcasing

的大小寫規則,以便快速確認該變數的作用域。

注釋轉換 c注釋 c 注釋

本專案基於乙個狀態機的思想,每次處理完成之後通過狀態的裝換繼續處理後邊的內容。另外,利用各類的檔案操作函式,實現將將c風格的注釋裝換成c 風格的注釋的乙個簡單功能。大概如下圖 什麼是狀態機?在本專案中,會用到四種狀態,既空狀態 正常 區 c注釋狀態 c風格注釋區 c 注釋狀態 c 風格注釋區 檔案結...

注釋轉化(C注釋轉為C 注釋)

假如現在有乙個.c的檔案,它裡面有c語言的注釋 c 的注釋 當然也有正常的 了,現在我們想要把裡面的注釋統一一下,將c語言注釋全部轉換為c 的注釋,該怎麼做呢?思路 我們可以這麼想,它裡面無非有四種型別 1.正常 2.c注釋 3.c 注釋 4.檔案結束標誌eof 我們要向把c注釋全部轉化成c 注釋,...

注釋轉換(C注釋轉換為c 注釋)

對於注釋轉換首先給出我的測試圖 由圖可以看出將左邊的c語言注釋轉換為右邊c 注釋就是注釋轉換 首先說明一下轉換思想方法 1.建立兩個檔案input.c和output.c,input.c裡面用來讀取c語言的注釋,output.c裡面儲存轉換成為c 的注釋,中間的轉換過程就是 完成,當然檔案名字和作用自...