码迷,mamicode.com
首页 > 其他好文 > 详细

自动化测试代码注释规范

时间:2017-05-15 19:39:16      阅读:195      评论:0      收藏:0      [点我收藏+]

标签:ring   reserve   htm   drive   驱动   setup   class   .com   工具   

原文链接: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();

        }

 

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

自动化测试代码注释规范

标签:ring   reserve   htm   drive   驱动   setup   class   .com   工具   

原文地址:http://www.cnblogs.com/zishi/p/6857606.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!