注释格式规范——《中国书法·书学》

注释格式规范——《中国书法·书学》
注释格式规范——《中国书法·书学》

程序代码注释编写规范

程序代码注释编写规范 为提高控制程序的阅读性与可理解性,现制定相关代码程序代码注释编写的编写规范。 一般情况下,源程序有效注释量必须在20%以上,注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始,任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始,以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能,与其他模块 // 或函数的接口,输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表,每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************************ COPYRIGHT (C), MicTiVo International. Co., Ltd. FileName: Author:

C语言注释规范

C语言注释规范 1.注释原则 同一软件项目开发中,尽量保持代码注释规范和统一。 注释方便了代码的阅读和维护。 边写代码边注释,修改代码时要相应修改注释,保证注释和代码的一致性。 注释要简洁明确,不要出现形容词。 对于写的好的注释,我们将是第一个受益者。 大型软件开发中,通过别人的注释可以快速知道他人所写函数的功能,返回值,参数的使用。 2.文件头部的注释 示例: / * Program Assignment : 该文件的作用 * Author: 作者 * Date: 2013/8/6 14:34 * Description: 该文件的描述 *****/ /* * Source code in : 源代码的路径 * Function List: * initLinear 初始化线性表 * destoryLinear 释放线性表申请的空间 * isLinearEmpty 判断线性表是否为空 * isLinearFull 判断线性表是否为满 * getLinearElementValue 取得下标为index的元素的值 */ 注意:这个函数列表可以快速查询到我们想要了解的函数。 3.结构体,全局变量等的注释 示例: typedef POLYNOMIAL USER_TYPE; /* 新的数据类型的描述*/ int a; /* 全局变量的作用*/ /* 说明结构体的功能*/ typedef struct LINEAR { USER_TYPE *data; /* 每个成员的意义(作用) */ int maxRoom; /* 每个成员的意义(作用) */

int elementCount; /* 每个成员的意义(作用) */ }LINEAR; 4.函数的注释 在逻辑性较强的的地方加入注释,以便其他人的理解,在一定的程度上排除bug。 示例: /* * Function Name: getLinearElementIndex * Purpose: 取得元素的index值 * Params : * @LINEAR linear 线性表实例 * @USER_TYPE var 类型为USER_TYPE的实例 * @int (*)() cmp 提供接口,让用户定义具体比较函数 * Return: int 返回元素的index值 * Limitation: 如果返回-1,则代表不存在var的元素 */ int getLinearElementIndex(LINEAR linear, USER_TYPE var, int (*cmp)()) { /* * 如果逻辑太过复杂,这里写明该算法的过程和思路。 */ boolean found = FALSE; int i; for(i = 0; i < && !found; i++) if(cmp[i], var) == 0) found = TRUE; if(i >= i = NOT_FOUND; return i; }

商务印书馆学术着作出版体例规范试行.doc

商务印书馆学术著作出版体例规范(试行) 一、文字规范 (一)一般性文字规范 1. 图书语言应符合现代汉语规范,除古籍整理、古汉语等方面的图书,以及其他 有特殊要求的书籍外,应使用现代汉语简体字,避免使用旧体字、异体字和繁体字,不 应繁简字混排。 2. 字词的使用力求规范。建议使用《现代汉语词典》的最新版作为统一标准。异 形词的标准写法以中华人民共和国教育部、国家语言文字工作委员会发布的《第一批异形词整理表》为准;未作规定的,建议使用《现代汉语词典》最新版的推荐词形。 3.数字使用应符合《出版物上数字用法的规定》。 4. 中文标点符号的使用要遵守《标点符号用法》的规定。外文标点符号的使用应遵循外文的规范用法。 5. 中外文混排时,如果整个句子主体为中文,只是在其中夹用一些外文单词、短 语的,则应使用中文标点。如果以中文起始,则以中文标点结句。如果整句、整段地引 用外文,引用部分应按所引文种的规定使用标点符号。 例示: 日常德语中的动词bestimmen 意为“规定”“、决定”等;海德格尔在此用的bestimmen 则有其特定意义。 相关观点,可参见 D. Sperber, Rethinking Symbolism. Cambridge: Cambridge University Press,1975 。 (二)专有名词规范 1. 人名、地名、书名、民族名、机构名、专业术语等专有名词,全书应统一。 2. 在正文中,专有名词原则上都应用中文标示。原词是外文的,除很通行的专有 名词之外,在第一次出现时,在译名后附上原文。对专有名词的译名应采用约定俗成或 学界通行的译法。如无通行译法,则分别按以下标准翻译: (1)人名的翻译原则应遵守名从主人的原则,即按照译者所属国别之语言的发音 进行音译。具体可按照商务印书馆出版的各语种的《姓名译名手册》及中国对外翻译出 版公司出版的《世界人名翻译大辞典》翻译。

最新国家标准公文格式

最新国家标准公文格式 标题(2号小标宋体) 发文对象:(标题下一行顶格,3号仿宋) X X X X X X X X X X(正文3号仿宋体字) 一、X X X(黑体) X X X X X X X X X X(正文3号仿宋体字) (一)X X X(楷体) X X X X X X X X X X(正文3号仿宋体字) X X仿宋 X X X X X X X X X X(正文3号仿宋体字) (1)X X X仿宋 X X X X X X X X X X X(正文3号仿宋体字) 附件: X X(正文下一行右空两字) X X 单位名称(附件下两行居成文日期中) 成文日期(右空四字,用阿拉伯数字)(联系人:……;联系电话:……)(如有附注,居左空二字加圆括号编 排在成文日期下一行。) (说明)1.标题:一般用2号小标宋体字,分一行或多行居中排布;回行时,要做到词意完整,排列对称,长短适宜,间距恰当,标题排列应当使用梯形或菱形。 2.正文:一般用3号仿宋体字,每个自然段左空二字,回行顶格。文中结构层次序数依次可以用“一、”“(一)”“1.”“(1)”标注;一般第一层用黑体字、第二层用楷体字、第三层和第四层用 仿宋体字标注。 3.附件:如有附件,在正文下空一行左空二字编排“附件”二字,后标全角冒号和附件名称。如有多个附件,使用阿拉伯数字标注附件顺序号(如“附件:1. XXXXX”);附件名称后不加标点符号。附件名称较长需回行时,应当与上一行附件名称的首字对齐。 附件应当另面编排,并在版记之前,与公文正文一起装订。“附件”二字及附件顺序号用3号黑

体字顶格编排在版心左上角第一行。附件标题居中编排在版心第三行。 4.发文机关署名:单一机关行文时,在正文(或附件说明)下空一行右空二字编排发文机关署名,在发文机关署名下一行编排成文日期,首字比发文机关署名首字右移二字,如成文日期长于发文机关署名,应当使成文日期右空二字编排,并相应增加发文机关署名右空字数。 5.成文日期中的数字:用阿拉伯数字将年、月、日标全,年份应标全称,月、日不编虚位(即 1不编为01)。 6.页码:一般用4号半角宋体阿拉伯数字,编排在公文版心下边缘之下,数字左右各放一条一字线;一字线上距版心下边缘7 mm。单页码居右空一字,双页码居左空一字。公文的版记页前有空白页的,空白页和版记页均不编排页码。公文的附件与正文一起装订时,页码应当连续编排。 此样式根据2012《党政机关公文格式国家标准》编写而成,标准中未提及具体行距,一般公文中标题行距28磅。正文及其他单倍行距。如有不当请指正。 函的写作格式 函的类别较多,从制作格式到内容表述均有一定灵活机动性。主要介绍规范性公函的结构、内容和写法。公函由首部、正文和尾部三部分组成。其各部分的格式、内容和写法要求如下: (一)首部。主要包括标题、主送机关两个项目内容。 1、标题。 2、主送机关。 (二)正文。其结构一般由开头、主体、结尾、结语等部分组成。 (三)结尾。一般用礼貌性语言向对方提出希望。或请对方协助解决某一问题,或请对方及时 复函,或请对方提出意见或请主管部门批准等。 (四)结语。通常应根据函询、函告、函或函复的事项,选择运用不同的结束语。如“特此函询()”、“请即复函”、“特此函告”、“特此函复”等。有的函也可以不用结束语,如属便函,可以 像普通信件一样,使用“此致”、“敬礼”。 (五)结尾落款。一般包括署名和成文时间两项内容。 署名机关单位名称,写明成文时间年、月、日;并加盖公章。 XXX关于XXX的函(2号小标宋体) 主送机关:(标题下一行顶格,3号仿宋) X X X X X X X X X X(正文3号仿宋体字) 特此函达,恳请批复。(结语灵活变动) 附件: X X(正文下一行右空两字) X X 单位名称(附件下两行居成文日期中) 成文日期(右空四字用阿拉伯数字)

华为JAVA编程规范

1 Java 编程规范 1.1 排版 1.1.1 规则 规则1程序块要采用缩进风格编写,缩进的空格数为4个,不允许使用TAB缩进。(1.42+) 说明:缩进使程序更易阅读,使用空格缩进可以适应不同操作系统与不同开发工具。 规则2分界符(如大括号…{?和…}?)应各独占一行,同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序 或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (a>b) { doStart(); } 规则3较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐, 语句可读。(1.42+) 示例: if (logger.isDebugEnabled()) { logger.debug("Session destroyed,call-id" + event.getSession().getCallId()); } 规则4不允许把多个短语句写在一行中,即一行只写一条语句(1.42+) 说明:阅读代码更加清晰 示例:如下例子不符合规范。 Object o = new Object(); Object b = null; 规则5if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 (1.42+) 说明:阅读代码更加清晰,减少错误产生 示例: if (a>b) { doStart(); }

行政公文格式规范标准

行政公文格式规 第一节公文格式的种类根据公文载体的不同,分为文件格式、信函格式、纪要格式等。 第二节公文格式的基本要求 1、公文用纸:一般使用纸定量为60g/m 2~80g/m 2的胶版印刷纸或 复印纸。纸白度80%~90%,横向耐折度≥15 次,不透明度≥85%,PH值为7.5 ~9.5 。 2、纸大小:A4 型纸:210mm×297mm。 3、版面:公文用纸天头(上白边)为37mm,公文用纸订口(左 白边)为28mm,版心尺寸为156×225mm。

4、 字体:如无特殊说明,各要素一般用 3 号仿宋字体。特定情况 可作 适当调整。 5、 行数和字数:一般每面排 22 行,每行 28 个字,并撑满版心。 特 定情况可作适当调整。 6、 公文应当双面印刷 7、 公文应当左侧装订

第三节公文的通用格式版头:份号、密级和期限、紧急程度、签发人。 主体:标题、正文、附件说明、署名、成文日期、印章、附注、附件。版记:印发单位、日期、页码。 一、版头部分 1、份号:公文的份数序号也就是每份公文的编号,根据印制份数, 编流水号。公文份数序号是为了掌握公文的发放方向,便于公文的管 理,便于掌握公文的动向。份号一般用6 位阿拉伯数字顶格编排在 版心左上角第一行。份号用黑色标注。 2、密级和期限:涉及公司秘密的公文应当标明密级和期限,公司秘 密分为秘密、和三种。 如需标注密级和期限,一般用3 号黑体字,顶格编排在版心左上角 份号之下;期限中的数字用阿拉伯数字。 3、紧急程度:紧急公文应当根据紧急程度分别标明“特急” 、 “加急”。 如需标注紧急程度,一般用3 号黑体字,顶格编排在版心左上角; 如需同时标注份号、密级和期限、紧急程度,按照份号、密级和期 限、紧急程度的顺序自上而下分行排列。 4、签发人:上报的公文需标识签发人。签发人平行居右空1 字。签 发人用3 号仿宋字体,签发人用3 号楷体字标注。

程序代码编写规范

程序编写规范及约定 (仅供内部使用) 文档作者:_______________ 日期:___/___/___ 开发/测试经理:_______________ 日期:___/___/___ 项目经理:_______________ 日期:___/___/___ 请在这里输入公司名称 版权所有不得复制

目录 程序编写规范及约定 (3) 1编写目的 (3) 2代码编写风格 (3) 2.1单元风格 (3) 2.2语句风格 (3) 3命名规则 (3) 3.1命名约定 (3) 3.1.1标志符 (3) 3.1.2类class (3) 3.1.3枚举类型enum (4) 3.1.4委托delegate (4) 3.1.5常量const (4) 3.1.6接口interface (4) 3.1.7方法function (4) 3.1.8命名空间namespace (4) 3.1.9参数 (4) 3.1.10局部变量 (5) 3.1.11数据成员 (5) 3.1.12自定义异常类 (5) 3.1.13命名缩写 (5) 3.1.14数据库命名 (5) 3.2代码编写命名规范 (6) 3.3界面常用控件命名约定 (6) 3.4文件命名规范 (7) 3.4.1文档文件命名 (7) 3.4.2配置文件命名 (7) 3.4.3程序文件命名 (7)

程序编写规范及约定 1编写目的 为了使编写代码具有可读性、可理解性、可维护性,对程序编写人员代码实行统一风格,使得程序代码能够以名称反映含义、以形式反映结构。此文档可供程序代码编写人员及代码维护人员使用。 2代码编写风格 2.1单元风格 2.2语句风格 3命名规则 3.1命名约定 Pascal和Camel命名约定: 编程的命名方式主要有Pascal和Camel两种(Pascal:每个单词的首字母大写,例如ProductType;Camel:首个单词的首字母小写,其余单词的首字母大写,例如productType) 3.1.1标志符 规则:Pascal、Camel 实例与描述:例子说明 3.1.2类class 规则:Pascal 实例与描述:Application

程序代码注释编写规范

百度文库- 让每个人平等地提升自我 1 程序代码注释编写规范 为提高控制程序的阅读性与可理解性,现制定相关代码程序代码注释编写的编写规范。 一般情况下,源程序有效注释量必须在20%以上,注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************* (C), MicTiVo International. Co., Ltd. 1.File : . History: Date: Author: Modification: 2. .. *************************************************/ 一、源文件头 源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************************ (C), MicTiVo International. Co., Ltd. FileName: Author: Version : Date: : / /*receive _process() */ 意:与溢出中断写初值不同}

云南大学出版社学术著作出版规范

第一章 法律规范 按照国家相关的法律、法规规定,公民有在出版物上自由表达对国家事务、经济和文化事业、社会事务的见解和意愿,自由发表从事科学研究、文学艺术创作和其他文化活动的成果的权利。同时,按照出版管理规定,出版物的出版要严格遵守《出版管理条例》《重大选题备案办法》等相关的法律法规。 一、出版物不得含有以下内容 (一)反对宪法确定的基本原则的; (二)危害国家统一、主权和领土完整的; (三)泄露国家秘密、危害国家安全或者损害国家荣誉和利益的; (四)煽动民族仇恨、民族歧视,破坏民族团结,或者侵害民族风俗、习惯的; (五)宣扬邪教、迷信的; (六)扰乱社会秩序,破坏社会稳定的; (七)宣扬淫秽、赌博、暴力或者教唆犯罪的; (八)侮辱或者诽谤他人,侵害他人合法权益的; (九)危害社会公德或者民族优秀文化传统的; (十)有法律、行政法规和国家规定禁止的其他内容的。 二、涉及宗教内容的,不得含有下列内容 (一)破坏信教公民与不信教公民和睦相处的; (二)破坏不同宗教之间和睦以及宗教内部和睦的; (三)歧视、侮辱信教公民或者不信教公民的; (四)宣扬宗教极端主义的; (五)违背宗教的独立自主自办原则的。

三、书稿需符合以下要求 (一)作品不得违反我国及其他授权出版地的法律、法规和政策,不得损害社会公共利益。 (二)以未成年人为对象的出版物不得含有会诱发未成年人模仿违反社会公德的行为和违法犯罪的行为的内容;不包含恐怖、残酷等会对未成年人身心健康造成妨害的内容。 (三)作品不得侵犯他人合法权利,不得含有侵犯他人名誉权、肖像权、姓名权等人身权内容。 (四)作品不侵犯他人的著作权、专利权、商标权等知识产权。 (五)作品中的插图、乐谱、照片等的版权来源合法,不侵犯他人的著作权或肖像权。 (六)作品所涉及的作者身份、职业、相关荣誉、作品以往发表情况等相关信息,应完整、真实。 第二章 学术著作规范 学术著作是作者根据某一学科或领域的研究成果而撰写的作品。这些作品或在理论上有创新见解,或在实践中有新的发明,或具有重要的文化积累价值。本处所指学术著作包括哲学社会科学、自然科学等学科的研究型著作,通俗理论读物、科普读物等不在其列。 学术著作出版必须坚持为人民服务、为社会主义服务的方向,贯彻“百花齐放、百家争鸣”的方针,促进学术创新、学术交流、学术积累,有益于经济发展和社会进步,有益于提高民族素质,弘扬优秀文化,促进国际文化交流。 引文、注释、参考文献、索引等是学术著作不可或缺的重要组成部分,体现了学术研究的真实性、科学性与传承性,体现了对他人成果和读者的尊

最新国家标准公文格式(2013新版)

最新国家标准公文格式(2013年) 标题(2号小标宋体) 发文对象:(标题下一行顶格,3号仿宋) X X X X X X X X X X(正文3号仿宋体字) 一、X X X(黑体) X X X X X X X X X X(正文3号仿宋体字) (一)X X X(楷体) X X X X X X X X X X(正文3号仿宋体字) 1.X X X仿宋 X X X X X X X X X X(正文3号仿宋体字) (1)X X X仿宋 X X X X X X X X X X X(正文3号仿宋体字) 附件:1.X X X(正文下一行右空两字) 2.X X X 单位名称(附件下两行居成文日期中) 成文日期(右空四字,用阿拉伯数字)(联系人:……;联系电话:……)(如有附注,居左空二字加圆括号编排在成文日期下一行。)

(说明)1.标题:一般用2号小标宋体字,分一行或多行居中排布;回行时,要做到词意完整,排列对称,长短适宜,间距恰当,标题排列应当使用梯形或菱形。 2.正文:一般用3号仿宋体字,每个自然段左空二字,回行顶格。文中结构层次序数依次可以用“一、”“(一)”“1.”“(1)”标注;一般第一层用黑体字、第二层用楷体字、第三层和第四层用仿宋体字标注。 3.附件:如有附件,在正文下空一行左空二字编排“附件”二字,后标全角冒号和附件名称。如有多个附件,使用阿拉伯数字标注附件顺序号(如“附件:1. XXXXX”);附件名称后不加标点符号。附件名称较长需回行时,应当与上一行附件名称的首字对齐。 附件应当另面编排,并在版记之前,与公文正文一起装订。“附件”二字及附件顺序号用3号黑体字顶格编排在版心左上角第一行。附件标题居中编排在版心第三行。 4.发文机关署名:单一机关行文时,在正文(或附件说明)下空一行右空二字编排发文机关署名,在发文机关署名下一行编排成文日期,首字比发文机关署名首字右移二字,如成文日期长于发文机关署名,应当使成文日期右空二字编排,并相应增加发文机关署名右空字数。 5. 成文日期中的数字:用阿拉伯数字将年、月、日标全,年份应标全称,月、日不编虚位(即1不编为01)。 6.页码:一般用4号半角宋体阿拉伯数字,编排在公文版心下边缘之下,数字左右各放一条一字线;一字线上距版心下边缘7 mm。单页码居右空一字,双页码居左空一字。公文的版记页前有空白页的,空白页和版记页均不编排页码。公文的附件与正文一起装订时,页码应当连续编排。 此样式根据2012《党政机关公文格式国家标准》编写而成,标准中未提及具体行距,一般公文中标题行距28磅。正文及其他单倍行距。如有不当请指正。

程序代码注释编写规范

程序代码注释编写规范 XXX份公司

为提高控制程序的阅读性与可理解性,现制定相关代码程序代码注释编写的编写规范。 一般情况下,源程序有效注释量必须在20%以上,注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始,任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始,以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能,与其他模块 // 或函数的接口,输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表,每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************************

公文的格式规范要求

公文的格式规范要求 广义公文:法定公文、专用公文、事务文书(蓝色为狭义公文)按使用范围公文分为15类:决议、决定、命令、公报、公告、通告、意见、通知、通报、报告、请示、批复、议案、函、纪要(其中决议和公报是XX年7月1日新增的) 按来源分为:上行文、下行为、平行文 按性质作用分:法规性公文、指挥性公文、报请性公文、公布性公文、通联性公文、记录性公文按保密程度分:绝密公文、机密公文、秘密公文 按办公时限要求分:特急件、加急件、平件(蓝色合称紧急文件) 党政机关法定公文中按规定只能单独使用不能加以合并 公文的格式规范 《党政机关公文格式》中将版心内的公文格式要素划分为版头、主体、版记三部分公文首页红色分隔线以上的部分称为版头;公文首页红色分隔线(不含)以下、公文末页首条分隔线(不含)以上的部分称为主体;公文末页首条分隔线以下末条分隔线以上的部分称为版记 1、版头 版头:一般由份号、密级和保密期限、紧急程度、发文机关标志、发文字号、签发人和版头中的分隔线组成

份号:一般用6位3号阿拉伯数字顶格编排在左版心左上角第一行 密级和保密期限:一般用3号黑体字顶格编排在版心左上角第二行;保密期限中的数字用阿拉伯数字标注 紧急程度:一般用3号黑体字顶格编排在版心左上角;如需同时标注份号、密级和保密期限、紧急程度按照份号、密级和保密期限、紧急程度的顺序自上而下分行排列 发文机关标志:由发文机关全称或者规范化简称加“文件”二字组成也可以使用发文机关全称或者规范化简称发文机关标志居中排布上边缘至版心上边缘为35mm推荐使用小标宋体字颜色为红色以醒目、美观、庄重为原则 发文字号:编排在发文机关标志下空二行位置居中排布发文字号由发文代字、年份、顺序号组成年份、发文顺序号用阿拉伯数字标注;年份应标注全称用六角括号“〔〕”扩入;发文顺序号不加“第”字不编虚位(即1不编01)在阿拉伯数字后加“号”字 上行文的发文字号居左空一字编排与最后一个签发人姓名处在同一行 版头中的分隔线:发文字号之下4mm处居中印一条与版心等宽的红色分隔线 签发人:由“签发人”三字加全角冒号和签发人姓名组成居右空一字编排在发文机关标志下空二行位置“签发人”三字用3号仿宋体字签发人姓名用3号楷体字

代码规范

目录 一.规范简介 1.1 目的 所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适应,但是在多个开发人员共同写作的情况下,这些规则是必需的。这不仅仅是为了开发效率来考虑,而且也是为了后期维护考虑。 本规范正是为培养规范设计和编程,养成良好的习惯,增强软件产品的稳定,健壮,可靠性;同时也为了提高软件的可读性,可以让程序员尽快而彻底地理解新的代码,使产品可维护性提高而制定的规范。 1.2 开发规范的重要性 (1)减少维护成本; 一个软件的生命周期中,80%的花费在于维护,另一方面,几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护,规范的编码减少人员变动带来的维护成本。 (2)改善软件的可读性 可以让程序员尽快而彻底地理解新的代码。在一个团队中,代码也容易在程序员之间共享。 (3)维护部门交付产品的规范形象。 二.具体规范 2.1 注释 注释是软件可读性的具体表现。程序注释量一般占程序编码量的20%,软件工程要求不少于20%。程序注释不能用抽象的语言,要精确表达出程序的处理说明。避免每行程序都使用注释,可以在一段程序的前面加一段注释,具有明确的处理逻辑。 注释必不可少,但也不应过多,不要被动得为写注释而写注释。

2.1.1 需要注释的部分 (1)文件头注释,文件创建及修改记录,版权归属,作者以及修订者,以及对文件的简短描述。 (2)类的目的(即类所完成的功能)、设置接口的目的以及应如何被使用。 (3)成员方法注释(对于设置与获取成员方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成功能,参数含义以及返回值)。 (4)普通成员方法内部注释(控制结构、代码所起到的作用以及如此编写代码的原因,处理顺序等)。 (4)参数的含义以及其他任何约束或前提条件、字段或属性描述。而对于局部变量,如无特别意义的情况下则不加注释。 2.1.2 具体注释 (1)文件头注释 要求:遵循JavaDoc的规范,在每一个源文件的开头注明该文件的作用, 作简要说明, 并写上源文件的作者,版权信息编写日期。如果是修改别人编写的源文件,要在修改信息上注明修改者和修改日期。 例子: /** * @Title: 文件名 * @Copyright (C) 年份龙图软件 * @Description: 文件信息描述 * @Revision History: * @Revision 版本号日期作者. */ (2)类和接口的注释 要求:遵循JavaDoc的规范,在每一个类的开头注明该类的作用,作简要说明,并写上作者,编写日期。 例子: /** * @ClassName: 类(或接口)名 * @Description: Description of this class

中国社会科学出版社学术体例规范(简化版)

中国社会科学出版社学术著作体例规范(简化版)(一)著作正文的篇章设置 1.著作正文的篇章设置须逻辑紧密、结构合理、层次清晰,标题序码一律用中文标示。示例: 第一章××××(第一级) 第一节××××(第二级) 一××××(第三级) (一)××××(第四级) 1. ××××(第五级) (1)××××(第六级) 2.篇章起始页以暗码标,正文页码放在书眉旁边。 (二)标点符号 中文标点符号使用全角,英文标点使用半角。 1.中文标点符号的使用要遵守《标点符号用法》的规定。注意: (1)句号、问号、叹号、逗号、顿号、分号和冒号不可出现在一行之首;引号、括号、书名号的前一半不可出现在一行之末,后一半不可出现在一行之首。 (2)一般文字的省略用省略号(……)标示;整段文章或诗行的省略,可以使用12个小圆点(…………)标示;数学矩阵或行列式中的行省略用“…”标示,矩阵中行内的省略用横排的“…”标示,列内的省略用竖排的“”标示。示例: (3)书名、篇名、报纸名、刊物名等,用书名号标示。 (4)外国人名和某些少数民族人名内各部分的分界,用间隔号(·)或半字线(-)标示。 (5)各级标题一般可以不用句末点号。但是,如果句末点号与语义的表达息息相关,就要加上句末点号。 (6)引文后注释号的位置,应根据引文的性质及上下文来确定。一般情况下,引用完整的一段话,点号在引号内,注释号(阳圆)在引号外;如果引者只是把引语作为自己话的一部分,即不完整的、夹引夹议和转述类的引文,那么,句末的点号应放在引号和注释号之后。示例: 文章认为:“语言与文化是共生的、互依的,两者息息相关:语言不但是文化重要而突出的组成部分,而且又是文化的一种表现形式;同时,它还是文化的产物。”①那情景,“人还没看见,已经先听见歌声了;或者人已经转过山头望不见了,歌声还余音 ①点号在引号内,注释号(阳圆)在引号外。

常用公文格式标准.docx

常用公文格式标准 为进一步规范公司公文格式,参照《国家行政机关公文格式》,结合公司工作实际,特制定本标准对几种常用公文格式进行规范。 一、请示报告请示报告适用于向公司领导请示工作,请求答复、批准。 1标题采用“关于×××××××的请示报告”字样,用小2号 宋体字(可加粗),可分一行或多行居中排布;回行时,要做到词意完整,排列对称,间距恰当。 2、标题下空1行,左侧顶格用 4 号宋体字写上“公司领导” (可加粗),之后标全角冒号,再下1行开始写正文。 3、正文用4 号宋体字,要简明扼要、层次清楚。 4、正文结尾单独一行左空 2 格写“妥否,请批示” 。 5、若有附件,在正文下空1行左空2字,标识“附件”,后标全角冒号和名称。公文仅有1个附件时,附件名称前不标识序号,有多个附件时,应在附件名称前用阿拉伯数码标识序号(如“附件:1. ×××””; 附件名称后不加标点符号。 6、最后以“××部门”和日期结束。日期要用汉字将年、月、日 标全;“零”写为“0” ;成文日期的标识位置应居右空4字。 7、请示报告必须要有起草部门负责人的亲笔签名,签名置于成文日期之下。 8、请示报告的具体格式样本见附件1。 二、报告 报告适用于向平级职能主管部门提交需求申请,需要主管部门给予明确的审核意见。涉及到费用的报告均提交给财务信息部,由财务信息部进行审核后向总裁提

交专项请示报告,请示报告中写明审核结论和意见建议,并附上申请部门的报告原件(或复印件)。人员调动申请向人力资源及管理部提交报告;办公物品采购申请向综合办公室提交报告。 1标题用“关于×××××××的报告”字样,用小2号宋体字 (可加粗),可分一行或多行居中排布;回行时,要做到词意完整,排列对称,间距恰当。 2、标题下空1行,左侧顶格用 4 号宋体字(可加粗)写上“财务信息部(或人力资源及管理部、综合办公室)”,之后标全角冒号,再下1行开始写正文。 3、正文用4号宋体字,每自然段左空2字,回行顶格。 4、若有附件,格式见前文。 6、最后以“××部门”和日期结束,格式见前文。 7、报告必须要有起草部门负责人的亲笔签名,签名置于成文日期之下。 8、报告的具体格式样本见附件2。 三、通知 通知适用于传达公司领导的指示;部署工作;下达各类计划;要求下级部门办理和需要有关部门周知或者执行的事项。 1通知的标题为“关于××××的通知”字样,用小2号宋体字 居中排列(可加粗) 2、标题下空1行,左侧顶格用 4 号宋体字写上“商管公司各部门(或特定的部门)”,之后标全角冒号,再下 1 行开始写正文。正文格式参照前文所述。 3、以“商业管理有限公司(或发文部门)”和日期结束。日期要用汉字将年、月、日标全;“零”写为“0” ;日期的标识位置应居右空 4 字。

C语言编写规范之注释

1、头文件包含Includes 2、私有类型定义 Private typedef 3、私有定义Private define 4、私有宏定义 Private macro 5、私有变量 Private variables 6、私有函数原型Private function prototypes 7、私有函数Private functions 8、私有函数前注释 /****************************************************************************** * * Function Name : FSMC_NOR_Init * Description : Configures the FSMC and GPIOs to interface with the NOR memory. * This function must be called before any write/read operation * on the NOR. * Input : None * Output : None * Return : None ******************************************************************************* / 9、程序块采用缩进风格编写,缩进空格为4。 10、相对独立的程序块之间、变量说明之后必须加空行; 11、较长的字符(>80字符)要分成多行书写,长表达式要在低优先级操作符划分新行,操作符放在新行之首,新行要恰当缩进,保持排版整齐; 12、循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首; 13、若函数或过程中的参数较长,则要进行适当的划分。 14、不允许把多个短语句写在一行中,即一行只写一条语句。 15、if、for、do、while、case、switch、default等语句自占一行,且if、for、 do、while等语句的执行语句部分无论多少都要加括号{}。 16、对齐只使用空格键,不使用TAB键; 17、 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case 语句下的情况处理语句也要遵从语句缩进要求 18、 程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一 列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以 及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 19、 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或

程序源代码注释规范

程序注释规范说明 程序注释规范应包括以下三方面: 一、文件头部注释 在代码文件的头部进行注释,这样做的好处在于,我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能,这在团队开发中必不可少,它们可以使后来维护/修改的同伴在遇到问题时,在第一时间知道他应该向谁去寻求帮助,并且知道这个文件经历了多少次迭代、经历了多少个程序员的开发和修改。 样本: /***************************************************** ** 作者:Liuchao ** 创始时间:2007-11-12 ** 修改人:Liuchao ** 修改时间:2007-11-12 ** 修改人:Liaochao ** 修改时间:2007-11-12 ** 描述: ** 主要用于产品信息的资料录入,… *****************************************************/ 二、函数、属性、类等注释 请使用///三斜线注释,这种注释是基于XML的,不仅能导出XML制作帮助文档,而且在各个函数、属性、类等的使用中,编辑环境会自动带出注释,方便你的开发。以protected,protected Internal,public声明的定义注释都建议以这样命名方法。 例如: ///

/// 用于从ERP系统中捞出产品信息的类 ///

class ProductTypeCollector { … } 三、逻辑点注释 在我们认为逻辑性较强的地方加入注释,说明这段程序的逻辑是怎样的,以方便我们自己后来的理解以及其他人的理解,并且这样还可以在一定程度上排除BUG。在注释中写明我们的逻辑思想,对照程序,判断程序是否符合我们的初衷,如果不是,则我们应该仔细思考耀修改的是注释还是程序了… 四、变量注释 我们在认为重要的变量后加以注释,说明变量的含义,以方便我们自己后来的理解以及其他人的理解,并且这样还可以在一定程度上排除BUG.我们常用///三斜线注释。 /// 用于从ERP系统中捞出产品信息的类 class ProductTypeCollector { int STData;/// … }

常用公文格式规范要求

常用公文格式有关要求 为实现党政机关公文格式规范统一,根据中共中央办公厅有关文件精神,现将有关常用公文格式规范具体要求如下: 一、公文用纸 公文用纸采用国际标准A4型(210mm×297mm),纸张定量为60g/m2~80g/m2的胶版印刷纸或复印纸。纸张白度为85%~90%,横向耐折度≥15次,不透明度≥85%,PH值为7.5~ 9.5。 二、排版规格 公文页边距尺寸: 公文用纸上白边为:36mm±1mm; 公文用纸左白边为:28mm±1mm; 版心尺寸为:156mm×225mm(不含页码)。 三、秘密等级 公文如需标识秘密等级,用3号黑体字,顶格标识在版心左上角第1行,两字之间空1字。 四、公文版头(发文机关标识) 公文版头由发文机关全称或规范化简称后加“文件”组成,对一些特定的公文可只标识发文机关全称或规范化简称。公文版头上边缘至上页边距为50mm±1mm,发文机关名称字号应小于22mm×15mm。 五、发文字号 发文字号由发文机关代字、发文年份和发文顺序号组成。

发文字号标注于版头下方居中,用3号仿宋体字。发文年份用阿拉伯数字标出全称,用六角括号“〔〕”括入。 六、横隔线(红色反线) 公文版头带“文件”二字的,横隔线由居中红色五角星加两侧红色横线组成。横隔线标于发文字号下,长度与版心等宽。 七、公文标题 公文标题由发文机关全称或规范化简称、公文主题和文种组成。公文标题标于横隔线下空1行,用2号小标宋体字,可一行或多行居中排布,回行时要做到词意完整,排列对称,间距恰当。 八、主送机关 主送机关是主要受理公文的机关,名称应用全称或规范化简称。主送机关标于标题下空1行,左侧顶格,用3号仿宋体字,回行时仍顶格,最后一个主送机关名称后标全角冒号。 九、公文正文 公文正文紧接主送机关名称下1行,用3号仿宋体字,每页排22行(Microsoft Office Word软件建议行间距:29磅),每行排28个字(Microsoft Office Word软件建议字间距:紧缩0.2磅)。 一级标题用3号黑体字,中文“一”,后标全角顿号和标题(如:“一、×××”)。二级标题用3号楷体字,阿拉伯数字“1.”,后标标题(如:“1.×××”)。数字、年份不回行。 十、公文附件 公文如有附件,在正文下1行,左空2字,用3号仿宋体

相关文档
最新文档