1、源程式注釋量需要達到**總量的20%以上。
2、為類編寫詳細的說明性檔案，格式如下：
/*****
*****
*****
*****
*****
*****
*****
*****
*****
****
* author:lian_lekai
* version:1.0.1
* date: 2015-01-21
* description:後台管理系統主檔案，主要作用是*
*****
*****
****
* others:
* function list:
* 1、註冊：*
*****
*****
****
* 2、登入：*
*****
*****
****
* 3、人員列表：*
*****
*****
****
* 4、裝置列表：*
*****
*****
****
* 5、修改密碼：*
*****
*****
****
* edithistory:
* 1. date:2015-02-11
* author:lian_lekai
* 2. ...
*****
*****
*****
*****
*****
*****
*****
*****
*****
****/
///
/// 使用post方法傳遞資料，並從伺服器獲取返回值
//////
傳送給伺服器的字串
///伺服器位址
///返回伺服器返回的字串
public
string
post(string json , string url)
說明：使用「//」進行注釋
5、全域性變數要有較詳細的注釋，包括對其功能、取值範圍、哪些函式或過程訪問它以及訪問時注意事項等的說明。
說明：注釋格式如下：
/*
* function:伺服器位址
* valuescope:fixed
* note:該變數存放的是伺服器的位址，只能進行訪問，不能改變。只提供了get訪問器。
*/private
string g_ip="";
public
string ip
}
說明：使用「//」進行注釋。
8、通過對函式或過程、變數、結構等正確的命名以及合理地組織**的結構，使**成為自注釋的。
說明：清晰準確的函式、變數等的命名，可增加**可讀性，並減少不必要的注釋。
規範 前端編碼規範 注釋規範
頂部新增檔案申明資訊，包括檔案描述 原始作者，如果有更新，則需要新增更新內容 更新作者和更新時間。description 說明文字 author 張三 description 說明文字 author 張三 update 更新內容 by 李四 2013 04 13 18 32 無論是單行注釋還是多行注...
Python命名，注釋等編碼規範
1.1 命名規範包名 全部小寫字母，中間可以由點分隔開，不推薦使用下滑線。模組名 全部小寫字母，如果多個單詞構成，可以用下劃線隔開。如dummy threading.類名 採用大駝峰法命名。如splitviewcontroller異常名 異常屬於類，命名同類命名，但應以error作為字尾。如file...
Python 注釋 縮排規則 編碼規範
一 注釋 單行注釋 多行注釋 三個連續的單引號 或者三個連續的雙引號 不支援巢狀，通常用來新增版權或者功能描述資訊 二 縮排規則 python採用 縮排和冒號 來區分 塊之間的層次 在 python 中，對於類定義 函式定義 流程控制語句 異常處理語句等，行尾的冒號和下一行的縮排，表示下乙個 塊的開...