1. 程式人生 > >自動化測試代碼註釋規範

自動化測試代碼註釋規範

online *** drive 成員 文檔自動生成 pan studio stl get

原文鏈接:http://www.cnblogs.com/zishi/p/6857606.html

一、頁頭加入代碼說明塊,格式如下:

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

[email protected]

[email protected] XXXXXX

[email protected] Modified by XXXXXX

[email protected]

[email protected] at 2017/12/6

[email protected] ? 2012 All Rights Reserved.

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

二、C#類、結構體及其成員註釋規範。類名前一定加入對類的描述風格為/// <summary>。類成員函數與成員變量分別用///<summary>與///註釋風格。///<summary>風格是visual studio針對C#代碼自帶的格式且與文檔自動生成工具doxygen兼容。示例代碼如下:

/// <summary>        

        /// 類的構造函數,傳遞INI文件名         

        /// </summary>        

        /// <param name="inipath">
傳入的ini文件名</param> public IniFile(string inipath) { Path = inipath; }

三、程序員內部註釋代碼註釋采用//風格,比如:

 public void SetUp()

        {

            TestLog.WriteLine("開始執行用例");

            //用戶信息

            UserHT = Config.GetUserHT();

            
//url信息 LinkHT = Config.GetLinkHT(); //首頁 baseURL = LinkHT["中文_生產_online"].ToString(); //驅動 driver = Browser.Start(); }

作者原創技術文章,轉載請註明出處

自動化測試代碼註釋規範