自动化测试代码注释规范

Posted 2020-09-18 William的小黑板

自动化测试代码注释规范

更多原创测试技术文章同步更新到微信公众号 ：三国测，敬请扫码关注个人的微信号，感谢！

 

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

 

一、页头加入代码说明块，格式如下：

 

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

*@file

*@author XXXXXX

*@remarks Modified by XXXXXX

*@version

*@Modified at 2017/12/6

*@Copyright © 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();

        }

 

作者原创技术文章，转载请注明出处