個人編碼模板

2021-08-26 12:36:17 字數 1154 閱讀 1131

1.4.1 一般性原則

1.4.2控制項命名原則

備註:各個控制項以首字母縮寫為基本原則,個別控制項可根據實際情況使用全命名方式,但必須小寫開頭,命名字首一覽;

應該包含如下: 

* 檔案描述 (description):描述此類的作用;

* 作者 (author):建立者或者修改者名;

* 版本 (version):建立或者修復時的編號,需要自行在bug管理系統中建立bug  號,使用bug號進行命名(若無bug管理工具的臨時辦法:如無bug號,從1開始,修改時依次增加)

* 日期(date):建立或者修改時的日期,使用「-」進行年月日分割;

* 記錄(record):建立或者修改的工作內容描述;

提前設定好檔案的模板template, 模板以下:

* description:

* author          version        date           record

* kevinlee        1              2017-11-7      版本建立

一般在寫完乙個方法後使用快捷鍵生成乙個塊注釋,ide會自動幫我們寫入一些資訊。 

應該包含如下資訊: 

* 方法描述 description: 

* 引數資訊 @param 

* 返回資訊 @return 

* 異常資訊 @exception 

如以下模板:

* description: 返回乙個「hello」字串

* @param str 乙個字串

* @return 返回乙個字串

* @throws exception  丟擲乙個異常

public  string  sayhello(string  str) throws  exception{

str="hello";

return  str;

注意:方法裡面不要使用塊注釋

應該包含如下資訊: 

* 一些程式關鍵的地方 ;

* 一些程式不易讀的地方 ;

* 編寫**過程中遇到問題的地方 ;

* 需要提示讀者的地方;

* 注釋易懂 ;     

應注意使用format來格式化**,使用tab鍵來縮排**,相當於4個空格。折行使用120字元寬度;

個人編碼風格

看不同於自己的編碼風格的 很難受。總結下自己的編碼風格如下,並不是意味著別人一定要這樣做,僅僅提供個人的一些看法。很多東西其實我也不一定贊同,例如究竟是用匈牙利還是用駝峰命名法,個人覺得只要變數能夠給人看上去有一定的含義就行了。1.運算子左右都有空格 一元運算子除外 2.函式名稱為動詞 名詞,變數名...

個人 編碼規範

一 變數命名 int i為字首 int arr為字首 int pi為字首 unsigend int ui為字首 unsigend int pui為字首 short s為字首 short ps為字首 unsigend short us為字首 unsigend short pus為字首 long l為字...

個人稀疏編碼筆記

b ax其中,a rn m b r n,x rm,n m 因為的行數 方程個數 n 多於未知引數的個數 m,因此上述方程組是欠定的,其解為 無解or無窮多解,為了保證上述方程有解,此後我們假定 a 是滿秩矩陣。我們追求的結果是找到 b 的稀疏表示方法,也即設法找到a,x使得在該對映變換下,x 是 b...