天強績效考核系統(tǒng)開發(fā)命名規(guī)范-wenkub
2023-04-22 23:06:13 本頁面
【正文】 Color.c. Upper Casing如果縮寫字母的個數(shù)小于或等于2，那么所有的縮寫字母都大寫。i5。例如://添加一個用戶函數(shù)對于源文件和類，必須在注釋中說明修改歷史2. 類和接口的注釋在summary中填寫類的簡要描述，remarks中填寫類的一些注意事項。例如：/// summary /// see cref=IUserManager/接口定義了see cref=User/實體類的增、刪、改、讀 /// （CRUD）方法，該接口的實現(xiàn)類將負責用戶對象的簡單管理。4. 方法的注釋/// summary /// 根據(jù)指定的用戶登錄名、姓名及密碼創(chuàng)建（注冊）一個新用戶（see cref=User/）。所有的public及protected方法都要注釋。 i 。對于循環(huán)語句（如while,do while,for），要說明循環(huán)繼續(xù)和終止的條件。4. 神秘的數(shù)字無論用何種語言編程，都不要出現(xiàn)神秘的數(shù)字，如下代碼應視為違反本規(guī)范：int n。如果僅僅是某個類中所使用的話，就作為常量寫入類中，例如：private const string SIGN_STATUS = “50”。5. ”{}”的使用相關聯(lián)的“{“和”}”要么處于同一行，要么處于同一列。在程序中的數(shù)字也并不一定屬于神秘的數(shù)字，以下情況是允許的：1， 索引數(shù)字，比如數(shù)組訪問，(2)?！瓕τ诔绦蛑幸玫降某?shù)，在專門的文件中進行定義，定義方法統(tǒng)一用大寫的英文，例如：public final int FILE_NAME_MAX_LENTH = 128。3. 漢語拼音盡量不要使用漢語拼音的聲母縮寫來做命名。例如要創(chuàng)建一個User對象的實體UserModel objUserModel=new UserModel；=”張三”。所有程序中的分支語句需要注釋分支條件意義，循環(huán)語句需要注釋循環(huán)的起始條件和中止條件。returns 填寫函數(shù)返回值以及返回值的意義。 /// /remarks /// Title: IUserManager /// Copyright: ***** Software Copyright (c) 2006 /// Company: *****有限公司/// Designer: ***/// Coder: 姜輝/// Reviewer: /// Tester: *** /// Version: /// History:/// 20060714 任維 [創(chuàng)建]/// 20060715 任維 [編碼]/// 20060810 任維[修改] 根據(jù)外部用戶需要,包裝GetUserNameById()WEB服務方法.3. 類成員變量的注釋類成員變量的注釋如下例所示：/// summary /// 用戶的名稱 /// /summary public string username。所有類和接口都要注釋。 e. 實體層數(shù)據(jù)庫實體文件命名 數(shù)據(jù)庫名稱 + Model結尾命名f. 實體層自定義實體文件命名 功能描述名詞 + Define結尾命名g. 實體層條件實體功能描述名詞 + Condition結尾命名h. 邏輯層文件命名 功能描述名詞i. 數(shù)據(jù)層文件命名 數(shù)據(jù)庫名稱二． 編程規(guī)范1. 代碼注釋原則上平均每100行代碼中要有20～30行注釋，視程序復雜程度而定。例如
公司管理相關推薦
鄂ICP備17016276號-1