程序開發是需要與別人合作共同開發的,所以代碼規範可以提高。多個人合作的時候的開發效率,也方便後期其他人對你開發的這個程序進行維護。
對於自己創建的代碼文件(如函數、腳本),在文件開頭,一般編寫如下注釋:
/*************************************************
作者:
小組:
說明:
創建日期:
版本號:
**********************************************/
在模塊、類、屬性、方法前一行添加註釋,以便調用的時候提示用戶
下以方法聲明做例子:
/// <summary>
/// depiction:<對該方法的說明>
/// </summary>
/// <param name="<參數名稱>"><參數說明></param>
/// <returns>
///<對方法返回值的說明,該說明必須明確說明返回的值代表什麼含義>
/// </returns>
如果模塊只進行部分少量代碼的修改時,則每次修改須添加以下注釋:
///修改人:
///修改日期:< YYYY-MM-DD >
///備份:
/* 原代碼內容*/
將原代碼內容註釋掉,然後添加新代碼使用以下注釋:
///添加人:
///添加日期: <YYYY-MM-DD>
代碼內容
///結束:
對於重構的類文件,需要對原來的類文件做備份,然後放在同級目錄下,在原有文件名後面添加後綴"_BAK",以便日後版本升級時整理源碼。
代碼間註釋分爲單行註釋和多行註釋:
單行註釋:
//<單行註釋>
多行註釋:
/*多行註釋1
多行註釋2
多行註釋3*/
代碼中遇到語句塊時必須添加註釋(if,for,foreach,……),添加的註釋必須能夠說明此語句塊的作用和實現手段(所用算法、循環條件、不同分支的意義等等)。
註釋的好處:
1 方便合作開發軟件
2 方便後期維護
3 縮短了開發時間
命名規範
控件命名
變量,常量,方法等等。
類,接口命名控件等等
這些內容都涉及到了,命名規範的問題。
使用命名規範的好處
1 對於控件命名的話,在我們寫代碼使用到控件的時候可以非常清晰的分清楚哪個控件是幹什麼用的,職責分明。而不用,在設計界面一通亂找。最後還沒找到。
2 變量和常量命名,體現在合作開發的時候。不同猜測這個功能是幹嘛的,而可以根據你的命名規則就可以體現出。這個變量或者這個方法具體的作用或功能。
3 還是上面註釋的好處一樣,可以提高開發效率。大大的縮短了開發時間,也做到了有效溝通。
編碼風格規範:
還是保持一個原則,遵從大多數人都可以使用的原則。而是個性化,因爲程序寫完之後是需要大家共同來維護的。所以使用標準化和官方定義不會產生二義性,也不會產生不必要的分歧。