C# 注释规范.docx

C#注释规范

第一篇：C#注释规范C#注释（Comment）规范注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释1.模块（类）注释规范模块开始必须以以下形式书写模块注释：//////模块编号：///作用：///作者：作者中文名///编写日期：///如果模块有修改，则每次修改必须添加以下注释：//////Log编号：///修改描述：///作者：修改者中文名///修改日期：///2.类属性注释规范在类的属性必须以以下格式编写属性注释：//////属性说明///3.方法注释规范在类的方法声明前必须以以下格式编写注释//////说明：//////">/////////4.代码间注释规范代码间注释分为单行注释和多行注释：单行注释：//多行注释：/*多行注释1多行注释2多行注释3*/代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。详细介绍见：http://第二篇：学术论文注释规范学术论文注释规范一、文后参考文献及其随文夹注格式参考文献按在正文中出现的先后次序列于文末，以“参考文献：”（左顶格）作为标识。参考文献的序号左顶格，并用数字加方括号表示，如[1]，[2]，…；每一条参考文献条目的最后均以小圆点“.”结束。引文的起止页码以随文以夹注的形式、用6号宋体标出，其格式为：[序号]（p×）。各类参考文献及其在正文中夹注的格式及示例如下：（一）专著、论文集、学位论文、报告[序号]主要责任者.文献题名[文献类型标识].出版地：出版者，出版年.[1]列维·布留尔.原始思维[M].北京：商务印书馆，1987.[2]马克思.恩格斯.共产党宣言[A].马克思恩格斯选集[M].第一卷.北京：人民出版社，1972.[3]洪亮吉.春秋左传诂[M].卷三.[4]人事部一·叙人[A].太平御览[M].北京：中华书局，1960.[5]皇甫湜.皇甫持正文集[M].卷四.四部丛刊本.[6]房玄龄等.晋书·司马彪传[M].北京：中华书局，1974.[7]Chester.TheRiseofBritishIndustrialSociety[M].Longman,1982.以例[6]、[7]为例，其随文夹注格式分别为：[6]（p.4142.）、[7]（p.289.）。多次引用同一本书中的材料，随文夹注中一律采用第一次出现的序号。例如：第一次引用[7]中材料时，夹注为“[7]（p289）”；第二次引用[7]中材料时，夹注为“[7]（p163）”。多种材料说明一个问题，在随文夹注中则按次序列出，例：“[4]（p×）；[5]（p×）”。（二）期刊文章[序号]主要责任者.文献题名[J].刊名，年，卷（期）.例：[8]李醒民.哲学不是敲门砖和摇钱树[J].学术界，2000，（1）.随文夹注格式：[8]（p206）。（三）论文集中的析出文献[序号]析出文献主要责任者.析出文献题名[A].原文献主要责任者（任选）.原文献题名[C].出版地：出版者，出版年.例：[9]王旭.美国三大城市与美国现代区域经济结构[A].中国美国史研究学会.美国现代化历史经验[C].北京：东方出版社，1994.随文夹注格式：[9]（p183）。（四）报纸文章[序号]主要责任者.文献题名[N].报纸名，出版日期（版次）.例：[10]杨玉圣.把书评当作学问来做[N].中华读书报，1996-10-09（2）.（五）电子文献[序号]主要责任者.电子文献题名[电子文献及载体类型标识].电子文献的出处或可获得地址，发表或更新日期/引用日期.例：[11]王明亮.关于中国学术期刊标准化数据库系统工程的进展[EB/CD].http://,1998-08-16/1998-10-04.报纸文章和电子文献在随文夹注中直接以序号标出，而省略“（p×）”著录项。（六）各种未定义类型的文献[序号]主要责任者.文献题名[Z].出版地：出版者，出版年.例：[12]何晓明.降落民间——21世纪中国历史学走向管窥（第十一届全国史学理论研讨会论文）[Z].武汉：湖北大学中国文化研究院，2000.二、参考文献与注释的区别参考文献是作者写作论著时所参考的文献书目，集中列于文末；注释则是作者对论著正文中某一特定内容的进一步解释或补充说明，列于该页地脚（以脚注形式标出）。参考文献序号用方括号标注，注释序号则用数字加圆圈标注，位于标点符号之后；若是直接引文，则位于后引号之后。附1：参考文献类型及其标识参考文献专著论文集析出文献报纸文章期刊文章学位论文报告文献类型标识MCANJDR无法根据上述分类的文献，其标识码一律用“Z”表示。附2：电子文献的载体类型及其标识（[文献类型标识/载体类型标识]）电子文献载体类型：磁带（magnetictape）——MT；磁盘（