FinalCode Group..C#代码规范V0.1

//----------------------------------------------------------------------------------------
// 北京航空航天大学微软俱乐部
// FinalCode Group
// CodeSpec.cs
// 创建日期:  2004年3月9日
// 功能摘要:
// 本文档作为FinalCode项目的一部分，用于描述项目开发中所有代码所需遵循的代码规范。
//-----------------------------------------------------------------------------------------
 
////说明:每个代码文件的开头必须包含如上部分
////1. 组名;2. 文档名;3. 创建日期;4.功能描述的摘要;
////这些部分必须用"//"注释，避免被文档生成工具加入到帮助文档中

using System;

namespace FinalCode
{
 /// <summary>
 /// 除了本文档顶部的注释以外，其他注释都必须采用C#的代码注释规范
 /// 即使用<summary></summary>等注释标签
 /// 以后可以使用/doc选项进行编译生成项目文档
 /// <see cref="ms-help://MS.VSCC.2003/MS.MSDNQTR.2003FEB.2052/csref/html/vclrfsummary.htm"/>
 /// <seealso cref="ms-help://MS.VSCC.2003/MS.MSDNQTR.2003FEB.2052/csref/html/vclrfTagsForDocumentationComments.htm"/>
 /// 此处应描述文档的功能描述，以下为示例:
 ///
 /// 本文档用于描述项目开发中所有代码所需遵循的代码规范
 /// 包括注释风格、命名风格以及代码风格三个部分。
 /// </summary>
 /// <remarks>
 /// summary标签用于添加基本的注释，而remarks标签用于添加额外的说明
 /// <see cref="ms-help://MS.VSCC.2003/MS.MSDNQTR.2003FEB.2052/csref/html/vclrfremarks.htm"/>
 /// 以下为示例:
 /// thanX的这个规范真是臭到家了:)，呵呵
 /// </remarks>
 public class CodeSpec
 {
  public CodeSpec()
  {
  }
       
        /// <summary>
        /// CodeSpecFuntionality1方法的功能描述用于描述，以下为示例:
        ///     CodeSpecFuntionality1方法用于描述代码注释风格
        /// </summary>
        /// <remarks>
        /// 关于CodeSpecFuntionality1的详细说明
        /// </remarks>
        /// <param name="para1">方法参数para1的说明放在这里，一行显示。例如: para1是为了描述代码注释风格而牺牲的好同志</param>
        /// <returns>返回值的说明放在这里，也是一行。</returns>
        public string CodeSpecFuntionality1(ref string para1)
        {
            string strResult; //局部变量的命名方式: "类型符（小写）+ 名字"
            bool bIfRight; //采用骆驼表示法
            strResult = ""; // 等于符号两边必须都空一格，其他诸如大于小于符号等类似
            bIfRight = true;
            for( int i=0; i<100; i++ )
            {
                //括号内必须两边都留空一格
                //括号内的等于符号以及其他符号不用留空
                //分号后面空一格
                //大括号为对应的格式，而非如下格式:
                //for(){
                //}
            }
          
            // Other Funtionality Code

            return strResult;
        }
       
        /// <summary>
        /// CodeSpecFuntionality2的功能说明
        /// </summary>
        /// <remarks>
        /// 必须的代码注释绝对不能偷懒，注释应该占到文档的1/3，但是也不能细致得过分
        /// 例如以下注释:
        /// //声明了一个整形变量a并且赋值为0
        /// int a = 0;
        ///
        /// 出现这种注释，我会把你砍死的，嘿嘿。
        /// </remarks>
        /// <returns>返回值的说明</returns>
        public string CodeSpecFuntionality2()       
        {
            string strResult2 = "";
            return strResult2;
        }

    }
}