说明书的写作
一、说明书写作的注意事项：
说明书要实事求是，有一说一、有二说二，不可为达到某种目的而夸大产品的作用和性能。
说明书要全面的说明事物，不仅介绍其优点，同时还要清楚地说明应注意的事项和可能产生的问题。
产品说明书、使用说明书、安装说明书一般采用说明性文字，而戏剧演出类说明书则可以以记叙、抒情为主。
说明书可根据情况需要，使用图片、图表等多样的形式，以期达到最好的说明效果。说明书的格式和写法
说明书多种多样，说明书的写作格式也不拘一格，不可一概而论。本文将举出一些常见的说明书的具体例子，以期使读者对此有一明确的认识。
二、说明书的分类
说明书各种各样。一般来讲，按所要说明的对象来分，可以分为商品说明书、影视戏剧说明书、旅游景点说明书、单位简介、人物简介等。按表述形式分类，可分为条款式说明书、文字图表说明书。说明书具有科学性、说明性、简明性和条理性的特点。
三、条款式说明书的写法（见教材41页）
四、说明书的作用
说明书的作用一般来讲有三点。
(一)解释说明的作用
解释说明是说明书的基本作用。随着我国经济的发展，人民生活的不断提高，工业、农业的飞速发展，文化娱乐活动也日益的繁荣，人们将会在生活生产中遇到许多各种各样的生产产品和生活消费品。科技的发展，更是使这些产品、消费品包含了很强的科技成分，所以为了使人民群众能很好地使用这些产品，真正为人民的生活服务，各生产厂家均会准备一本通俗是易懂的产品或生活日用消费品的说明书，给用户的使用以切实的指导和帮助。说明书要详细地阐明产品使用的每一个环节和注意事项。
(二)广告宣传的作用
商品经济的今天，说明书的广告宣传作用也是不可忽略的。好的说明书可以使用户产生购买欲望，达到促销的目的。
(三)传播知识的作用
说明书对某种知识和技术有传播作用。如介绍产品的工作原理、主要的技术参数、零件的组成等。
例题：剃须刀的使用说明书
(真汉子剃须刀)使用说明书
本说明适用于各类充电式剃须刀。
充电：
将电源插头插入AC220V电源之中，视充电指示灯亮、充电12-16小时。注意：充电时间不要过长，以免影响电池寿命。
剃须：
将开关键上推至(on)开启位置，即可剃须。为求最佳之刮须效果，请将皮肤拉紧，使胡子成直立状，然后以逆胡子生长的方向缓慢移动。
修剪刀：
如有修剪刀功能的剃须刀，请在剃须前，先将修剪刀推出，修短胡须后再用网刀剃净。
清洁：
剃须刀要经常清洁。清洁前应先关上开关。旋下网刀，用毛刷将胡须屑刷净。清洁后轻轻放回刀头架、且到位。清洁时应轻拿轻放，避免损坏任何部件。
保修条例：
保修服务只限于一般正常使用下有效。一切人为损坏例如接入不适当电源，使用不适当配件，不依说明书使用；因运输及其它意外而造成之损坏；非经本公司认可的维修和改造，错误使用或疏忽而造成损坏；不适当之安装等，保修服务立即失效。此保修服务并不包括运输费及维修人员上门服务费。
保修期外享受终身维修，维修仅收元器件成本费。
剃须刀中内、外刃属消耗品不在保修范围内。
保修期：正常使用六个月。
注意事项：
充电时间12～16小时。
换刀网刀头时一定要选用原厂配件。
评析：
这是一篇剃须刀的使用说明书。该使用说明书还附上了“保修条例”部分，严格来讲，“保修条例”不属于使用范围内的东西，可以略去。就其使用说明来讲，该文谈到
三个主要的步骤，一是充电，二是剃须，三是清洁。这类剃须刀属于充电式的，由于刚打开的产品尚未充电，故要求先充电。该部分介绍了所接用的充电电压，充电时间及注意事项等。
剃须部分将剃须的具体方法，剃刀走动的方向等都介绍的很清楚。除此而外，还指出有“修剪刀”的剃刀可在剃须前先将长须修短，再用剃须刀剃净。
清洁是剃须后必做的工作，这里详细地介绍了剃须刀的保养清洁工作。为延长剃须刀的寿命这都是很有必要的。
1、涉及机械产品的撰写实例 实例之一：试电笔 说明书 试电笔 技术领域 本专有技术涉及一种指示电压存在的试电装置,尤其是能识别安全和危险电压的试电笔。 背景技术 目前,市售的试电笔构造是由测试触头、限流电阻、氖管、金属弹簧和手触电极串联而成。将测试触头与被测物接触,人手接触手触电极，当被测物相对大地具有较高电压时，氖管启辉，表示被测物带电。但是,很多电器的金属外壳不带有对人体危险的触电电压,仅由于分布电容和/或正常的电阻感应产生电势,使氖管启辉。一般试电笔不能区分有危险的触电电压和无危险的感应电势,给检测漏电造成困难,容易造成错误判断。 专有技术内容 本专有技术的目的是提供一种试电笔,它不仅能测出被测物是否带电,而且能方便地区分是危险的触电电压还是无危险的感应电势。 本专有技术的目的是这样实现的:在绝缘外壳中,测试触头、限流电阻、氖管和手触电极电连接,设置一分流电阻支路,使测试触头与一个分流电阻一端电连接,分流电阻另一端与一个人体可接触的识别电极电连接。当人手同时接触识别电极和手触电极时,使分流电阻并联在测试触头、限流电阻、氖管、手触电极电路中。测试时,人手只和手触电极接触,氖管启辉,表示被测物带电。当人手同时接触手触电极和识别电极时,若被测物带有无危险高电势时,由于电势源内阻很大,从而大大降低了被测物的带电电位,则氖管不启辉,若被测物带有危险触电电压,因其内阻小,接入分流电阻几乎不降低被测物带电电位,则氖管保持启辉,达到能够区别安危电压的目的。 由于采用上述方案,可以在测试是否带电的同时方便地区分安危电压,分流支路中仅采用电阻元件,结构简单。 本发明随后将通过其具体实施例和附图加以说明。 附图说明 图1是本专有技术的电路原理图； 图2是试电笔第一个实施例的纵剖面示意图； 图3是图2的I-I剖视图； 图4是试电笔第二个实施例的纵剖面构造图。 图中标注:1.测试触头、2.绝缘外壳、3.弹簧、4.同心电阻、5.限流电阻、6.分流电阻、7.识别电极、8.氖管、9.弹簧、10.后盖、11.手触电极、12.绝缘隔离层、13.弹簧。 具体实施方式 在图1中,测试触头1、限流电阻5、氖管8与手触电极11串联,测试触头1与分流电阻6一端相连,分流电阻6另一端与识别电极7相连。通常限流电阻阻值为几兆欧,为保证人身安全,分流电阻阻值不小于限流电阻阻值,最好取限流电阻阻值1至2倍。 在图2所示实施例中,测试探头1从绝缘外壳2一端伸入其中空腔,与弹簧3接触，弹簧3另一端与同心电阻4相接触,同心电阻4的纵剖面为E形,其中间圆
写作基础知识之说明方法 导读：说明方法： 1、举例子： 举出实际事例来说明事物，使所要说明的事物具体化，以便读者理解，这种说明方法叫举例法。如：一般人总以为，年龄稍大，记忆能力就一定要差，其实不然，请看实验结果：国际语言学会曾对9至18岁的青年与35岁以上的成年人学习世界语作过一个比较，发现前者就不如后者的记忆力好。 2、分类别： 将被说明的对象，按照一定的标准划分成不同的类别，一类一类地加以说明，这种说明方法，叫分类别。分类别是将复杂的事物说清楚的重要方法。如图书馆的藏书，按国别分，有中国的、外国的;按时代分，有古典的、现代的;按性质分，有科技的、文学的以及政治经济方面的等。 3、下定义： 用简明的语言对某一概念的本质特征作规定性的说明叫下定义。下定义能准确揭示事物的本质，是科技说明文常用的方法。下定义的时候，可以根据说明的目的需要，从不同的角度考虑。有的着重说明特性，如关于“人”的定义;有的着重说明作用，如关于“肥料”的定义;有的既说明特性又说明作用，如关于“统筹方法”和“应用科学”的定义。
①人是能制造工具并使用工具进行劳动的高级动物。 ②肥料是能供给养分使植物生长的物质。 ③统筹方法，是一种安排工作进程的数学方法。 ④工程技术的科学叫做应用科学，它是应用自然科学的基础理论来解决生产实践中出现的问题的学问。 无论从什么角度考虑，无论采用什么方式，只要是下定义，就必须揭示事物的本质，只有这样的定义才是科学的。比如，有人说：“人是两足直立的动物。”这个定义就是不科学的，因为它没能揭示事物的'本质。“人是能制造工具并使用工具进行劳动的高级动物。”这才是科学的定义，因为它揭示了人的本质。 4、作诠释： 从一个侧面，就事物的某一个特点做些解释。下定义和作诠释常采用“某某是什么”的语言形式。形式相同，如何区分呢?一般来说，“是”字两边的话能够互换，就是定义;如果不能互换，就是诠释。 5、打比方： 利用两种不同事物之间的相似之处作比较，以突出事物的性状特点，增强说明的形象性和生动性的说明方法叫做打比方。说明文中的打比方的说明方法，同修辞格上的比喻是一致的。不同的是，比喻修辞有明喻、暗喻、和借喻，而说明多用明喻和暗喻，借喻则不宜使用。 6、引用： 为了使说明的内容更充实具体，可以引资料说明。引资料的范围
网站说明书（报告）撰写规范 （一）正文：汉字应采用《简化汉字总表》规定的简化字，并严格执行汉字的规范。所有文字字面清晰，不得涂改。要求文字通顺，语言流畅，无错别字，不得使用铅笔书写。正文内容层次序号为：1、1.1、1.1.1……。 正文内容一般为： 1、网站主题内容及总体结构描述。 2、网页设计思路和过程论述 3、结论和总结：对开发过程的总结和心得体会。 （二）表格 说明书（报告）的表格统一编序（如：表15）。表序必须连续，不得重复或跳跃。 表格的结构应简洁。 表格中各栏都应标注量和相应的单位。表格内数字须上下对齐，相邻栏内的数值相同时，不能用‘同上’、‘同左’和其它类似用词，应一一重新标注。 表序和表题置于表格上方中间位置，无表题的表序置于表格的左上方或右上方（同一篇论文位置应一致）。 （三）图 插图要精选。图序连续编序（如图52），不得重复或跳跃。仅有一图时，在图题前加‘附图’字样。课程设计中的插图以及图中文字符号应打印，无法打印时一律用钢笔绘制和标出。 由若干个分图组成的插图，分图用a,b,c,……标出。 图序和图题置于图下方中间位置。 （四）数字用法 公历世纪、年代、年、月、日、时间和各种计数、计量，均用阿拉伯数字。年份不能简写，如1999年不能写成99年。数值的有效数字应全部写出，如：0.50:2.00不能写作0.5:2。 （五）排版与封面要求 1、排版 用word排版，具体格式如下：
版面要求：页边距：上2.5cm，下2.5cm，左3cm，右2.5cm； 字体：正文宋体、小四，章节标题宋体、小三； 行距：固定值20； 页码：居中、底部。 2、封面
xxxxxx项目 详细设计说明书编写指南 编写单位
详细设计说明书编写指南变更履历
目录 第一章前言 (4) 1.1编写目的 (4) 1.2文档内容 (4) 第二章详细设计说明书的编写要求 (5) 2.1引言 (5) 2.1.1 编写目的 (5) 2.1.2 背景 (5) 2.1.3 定义 (5) 2.1.4 参考资料 (5) 2.2子系统设计 (5)
第一章前言 1.1 编写目的 本文旨在指导项目建设单位和承建单位编写详细设计说明书，详细设计是软件工程中软件开发的一个步骤，是对概要设计的细化过程。由于各承建单位采用的设计方法不尽相同，本文档提出详细设计阶段必须完成的工作内容，但不限制采用的设计方法和对详细设计成果的展现形式，各承建单位可以根据实际情况自行确定描述方法和展现形式。本文中的示例仅供参考。 1.2 文档内容 本指南主要包含以下内容： 一、描述详细设计说明书的编写要求。 二、举例说明详细设计说明书的编写方法。
第二章详细设计说明书的编写要求 本章节主要描述详细设计说明书的编写要求。详细设计说明书需满足“2.1引言”章节的内容和格式要求；详细设计说明书需满足“2.2章节”的内容要求，不限制格式。 各项目建设单位和承建单位编写详细设计说明书要满足本章的内容要求，不限制格式。 2.1 引言 2.1.1 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者。 2.1.2 背景 描述详细设计阶段的目标、作用范围以及其他应向读者说明的理解本文档所需的背景，如与公司其它软件之间的联系等。 2.1.3 定义 列出本文件中用到专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇，同时要求继承全部的先前过程中定义过的词汇。 2.1.4 参考资料 列出有关的参考资料，如： 1、本项目的经核准的计划任务书或合同、上级机关的批文； 2、属于本项目的其他已发表的文件； 3、本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。 2.2 子系统设计 本章描述详细设计阶段对每个模块的设计，包括实现算法、局部数据结构等内容。各项目可根据采用的详细设计方法，以说清楚对每个模块的设计为目的，
产品说明书的写作方法 产品说明书的写法 （一）了解产品说明书的涵义：产品说明书是一种全面、明确地介绍产品的用途、性能、构造、使用方法等事项的文字材料，是一种比较常见的说明文。 （二）了解说明书的作用： （1）传播知识。当说明书伴随着产品走向消费者群的时候，它所包含的新知识、新技术，也为群众所了解。 （2）指导消费。说明书对商品或服务内容进行客观的介绍、科学的解释，可以了解产品的特性、掌握产品的操作程序，从而达到科学消费的目的。 （4）宣传企业。说明书在介绍产品的同时，也宣传了企业，因而兼有广告宣传的性质。 （三）产品说明书的特点有哪些？ （1）内容的科学性。产品说明书以传授产品知识为主，科学性是对产品说明书的必然要求。 （2）表述的通俗性。以通俗浅显的语言，将产品个方面的情况说明，以便各个层次的消费者都易于理解。 （3）层次的条理性。这是说明性文体的共同要求。说明要条款清晰，层次清楚。
二、了解说明书的写作要领 （一）产品说明书的结构和内容。 产品说明书一般由标题、正文、尾部等几部分构成。 1、标题：通常由说明对象或产品名称组成。 2、正文：正文要写明产品的基本情况，产品的性能、用途、构造以及使用方法、保养维修常识等。不同说明书的内容侧重点也有所不同。一般的产品说明书分为⑴家用电器类。⑵日用生活品类。⑶食品药物类。⑷大型机器设备类。⑸设计说明书。附文。厂名、地址、电话、电挂、电传、联系人和生产日期等。出口产品在外包装上写明生产日期、中外文对照。 （二）撰写产品说明书的注意事项 第一，要有责任意识； 第二，要有大众意识。 第三，突出产品特点。要注意广告和说明书的区别。如“喝孔府家酒，做天下文章”可做广告语，写入产品说明书不合适。语言要求准确、通俗、简明。尽可能图文并重。 三、产品说明书与广告的区别有哪些？ （1）目的不同。说明书的目的是介绍商品知识；广告的目的是促进商品的销售、推广经营 理念。
附件3 专利说明书撰写要求 发明创造名称 (1) 发明名称一般不得超过25个字，化学领域的某些申请，可以允许最多到40个字； (2) 采用通用的技术术语，不得采用非技术术语； (3) 写明本发明主题和类型（产品或者方法），例如一件包含拉链产品和该拉链制造方法两项发明的申请，其名称应当写成“拉链及其制造方法”； (4) 不得使用人名、地名、商标、型号或者商品名称等，也不得使用商业性宣传用语，如“新型的”、“具有优越性能的”等。 名称确定后，说明书请按照以下几个部分及要求撰写： (一)技术领域： 发明或者实用新型的技术领域应当是其所属或者直接应用的具体技术领域，例如，一项关于挖掘机悬臂的发明，其改进之处是将现有技术的长方形悬臂截面改为椭圆形截面。其所属技术领域可以写成“本发明涉及一种挖掘机悬臂”（具体的技术领域），而不宜写成“本发明涉及一种建筑机械”（领域太广），也不宜写成“本发明涉及一种截面为椭圆形的挖掘机悬臂”（发明本身）。 (二) 背景技术 背景技术就是与本发明相关的现有技术，背景技术应当写明对相关现有技术的理解、检索，并且尽可能引证这些现有技术的文件。尤其要引证与本发明最相关的现有技术文件，并简要说明所引证技术文件的主要技术方案。引证的文件可以是专利文件，也可以是非专利文件，如期刊、杂志、手册和书籍等。引证专利文件的，至少要写明专利文件的国别、公开号，最好包括公开日期；引证非专利文件的，要写明这些文件的标题和详细出处。同时要客观地指出现有技术中存在的问题和缺点，但是，这些问题和缺点仅限于本发明所要解决的问题和缺点。(三)发明或者实用新型内容 本部分应当清楚、客观地写明以下内容： (1) 要解决的技术问题（发明目的） 本发明要解决的技术问题，是指本发明要解决的相关现有技术中存在的技术问题。本发明记载的技术方案是为了解决这些技术问题。 发明目的应当按照下列要求撰写： (i) 针对现有技术中存在的缺陷或不足； (ii)用正面的、简洁的语言客观而有根据地说明本发明本要解决的技术问题，如“本发明为了解决……的问题，提供一种……的产品或方法”也可以进一步说明其技术效果。但尽量不要采用广告式宣传用语。 一件专利申请可以列出一个或者多个要解决的技术问题，但这些技术问题应当都与一个总的发明构思相关。 (2) 技术方案 技术方案是本发明为解决上述技术问题所采取的技术手段或技术特征。在技术方案这一部分，应采用概括性语句，清楚、完整地写明完成本发明任务的那些必不可少的技术手段/技术特征，并尽量不要写入技术原理、功能或效果的内容。功能和效果应在下一部分中描写。 (3) 有益效果 有益效果是指，与最接近的现有技术相比，本发明所产生的技术效果，这些效果是由构成本发明的技术方案所直接带来的，或者是本发明技术方案必然产生。通常，技术效果可以由产率、质量、精度和效率的提高，能耗、原材料、工序的节省，加工、操作、控制、使用的简便，环境污染的治理，以及产品性能提高等方面反映出来。
关于“参考文献“的写作要求 时间：2008-09-01 来源：本站整理作者：本站编辑 文献指作者在论文中直接引用的、最主要的、发表在正式出版物上的文献。未正式发表的文献(包括私人通讯,毕业论文等)一般不作为文献引用,必要时可作为脚注处理。参考文献的作者不超过3个人时全部列出,多于3人时只列前3人,后加“等“字”或”“et al”。姓名采用姓前名后的形式,外国人姓写全称,名缩写,作者之间用逗号分开,而不用“和”或“and”。外国期刊名可缩写,但必须标准、规范。引用论著要写明书名、版次、出版地、出版社、出版年和页码等,引用期刊要写明标题、期刊名称、出版年、卷期和页码等。 参考文献书写格式举例: 期刊: [1] 阴宏,马红,刘乃慧,等.大鼠阻塞性肝纤维化模型的建立.实验动物科学与管理,2002,19(2):1~3. [2] Garrido F, Cabrera T, Concha Aet al. Natural history of HLA antigens during tumour development.Immunol Today, 1993,14:491. 图书: [3] 田克恭.实验动物病毒性疾病.北京:中国农业出版社,1992.389~392. [4] 董志扬,张树政,方宣钧,等.海藻的生物合成及抗逆机理.见:华珞等.核农学进展.北京:中国农业出版社,1996.115~120. 专利文献的编排格式: 按专利申请者,专利题名,其他责任者(供选择项),附注项(供选择项),文献标识符(专利国别,专利文献种类,专利号,出版日期)顺序编排。 医学论文的写作格式及内容要求 时间：2008-07-01 来源：本站整理作者：本站编辑 1．文稿应具有科学性、创造性、实用性、逻辑性,论点明确,资料可靠,文字精炼,层次清楚,数据准确,重点突出,书写工整规范,必要时应做统计学处理。论著、综述、讲座一般不超过6 000字,论著摘要及经验交流不超过2 000字,短篇或个案报道以500~1 000字为宜。 2．文题力求确切、简明、醒目,反应出文章主题。涉及物理疗法的文题,应以物理因子命名。中文文题一般以20个汉字以内为宜。 3．作者作者排序应在投稿时确定,在编排过程中不应再作变更。作者应是:①参与选题和设计,或参与资料的分析和解释者;②起草或修改论文中关键性理论或其他主要内容者;③能对编辑部的修改意见进行核修,在学术上进行答辩,并最终同意该文发表者。以上3条均需具备。仅参与获得资金或收集资料者不能列为作者,仅对科研小组进行一般管理也不宜列为作者。对文章中的各主要结论,均必须至少有1位作者负责。集体署名的文章必须明确对该文负责的关键人物;其他对该研究有贡献者应列入志谢部分。作者中如有外籍作者,应征得本人同意,并有证明信。 4．.摘要论著须附中英文摘要,摘要必须包括目的、方法、结果(应给出主要数据)及结论四部分,各部分冠以相应标题。采用第三人称撰写,不用“本文”、“作者”等主语。中英文摘要各400字左右。英文摘要尚应包括文题、作者姓名(汉语拼音)、单位名称、所在城市名及邮政编码和国名。作者应列前3位,3位
说明文写作的说明方法 说明文是以说明为主要表达方式来解说事物、阐明事理而给人知识的文章体裁。它通过揭示概念来说明事物特征、本质及其规律性。 说明文实用性很强，它包括广告、说明书、提要、提示、规则、章程、解说词、科学小品等。说明文一般介绍事物的形状、构造、类别、关系、功能，解释事物的原理、含义、特点、演变等。说明的方法 1、常见的说明方法有：举例子、分类别、下定义、摹状貌、作诠释、打比方、列数字、列图表、 引用说明。 2、常见说明方法的作用： ①、举例子：通过举具体的实例对事物的特征/事理加以说明，从而使说明更具体，更有说服力。②、分类别：对事物的特征/事理分门别类加以说明，使说明更有条理性。 ③、作比较：把__________和__________加以比较，突出强调了事物的特征/事理。④、作诠释：对事物的特征/事理加以具体的解释说明，使说明更通俗易懂。 ⑤、打比方：将__________比作__________，从而形象生动地说明了事物的特征/事理。⑥、摹状貌：对事物的特征/事理加以形象化的描摹，使说明更具体形象。
⑦、下定义：用简明科学的语言对说明的对象/科学事理加以揭示，从而更科学、更本质、更概括 地揭示事物的特征/事理。 ⑧、列数字：用具体的数据对事物的特征/事理加以说明，使说明更准确更有说服力。⑨、列图表：用列图表的方式对事物的特征/事理加以说明，使说明更简明更直观。⑩、引用说明：引用说明有以下几种形式—— A、引用具体的事例；（作用同举例子） B、引用具体的数据；（作用同列数字） C、引用名言、格言、谚语；作用是使说明更有说服力。 D、引用神话传说、新闻报道、谜语、轶事趣闻等。作用是增强说明的趣味性。（引用 说明在文章开头，还起到引出说明对象的作用。） 二、说明文的语言品析 1、对整篇文章语文的品析，一般从二个角度谈：A、准确；B、形象生动或简明平实。A是一般说明文的共同特点。B是针对不同语文风格的角度谈。做这种评析整篇文章语言特点的题目，一定要结合文章具体内容谈，比如可以选择一句话为例子。
＜项目名称＞ 数据要求说明书 作者： 完成日期： 签收人： 签收日期： 修改情况记录：
目录 1 引言 (1) 1.1 编写目的 (1) 1.2 范围 (1) 1.3 定义 (1) 1.4 参考资料 (1) 2 数据的逻辑描述 (1) 2.1 静态数据 (2) 2.2 动态输入数据 (2) 2.3 动态输出数据 (2) 2.4 内部生成数据 (2) 2.5 数据约定 (2) 3 数据的采集 (2) 3.1 要求和范围 (2) 3.2 输入的承担者 (3) 3.3 预处理 (3) 3.4 影响 (3)
1 引言 1.1 编写目的 说明编写这份数据要求说明书的目的，指出预期的读者范围。 1.2 范围 说明： a．待开发的软件系统的名称； b．列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 数据的逻辑描述 对数据进行逻辑描述时可把数据分为动态数据和静态数据。所谓静态数据，指在运行过程中主要作为参考的数据，它们在很长的一段时间内不会变化，一般不随运行而改变。所谓动态数据，包括所有在运行中要发生变化的数据以及在运行中要输入、输出的数据。进行描述时应把各数据元素逻辑地分成若干组，例如函数、源数据或对于其应用更为恰当的逻辑分
说明文的说明方法 1.举例子 使文章更加具体，更有说服力，更客观地说明了事物。使比较抽象，复杂的事情或事物变得通俗易懂，让人信服。举例子必须让人觉得有真实感。 2.打比方 利用两种不同事物之间的相似之处作比较，以突出事物的性状特点，增强说明的形象性和生动性的说明方法叫做打比方。说明文中的打比方，同修辞方法中的比喻是一致的。用这个方法，可以把抽象复杂的事物说得浅显易懂，具体生动。不同的是，比喻修辞有明喻、暗喻、和借喻，而说明多用明喻和暗喻，借喻则不宜使用。（把……比作……，体现了……的……特点……） 3.下定义 用简明的语言对某一概念的本质特征作规定性的说明叫下定义。从而更科学、更本质、更概括地揭示事物的特征/事理。下定义能准确揭示事物的本质，是科技说明文常用的方法。 4.列图表 为了把复杂的事物说清楚，还可以采用图表法，来弥补单用文字表达的缺欠，对有些事物解说更直接、更具体。使读者直观，一目了然地了解事物的特征。 5.诠释法 诠释法又称作诠释。从一个侧面，就事物的某一个特点做些解释，这种方法叫诠释法。（引.....的例子，说明…….....的…….....的特点。）甲=乙，乙≠甲 6.作比较 1、说明某些抽象的或者是人们比较陌生的事物，可以用具体的或者大家已经熟悉的事物和它比较，使读者通过比较得到具体而鲜明的印象。 2、利用两种不同事物之间的相似之处作比较，以突出事物的形状特点。 7.摹状貌(现在学校大多不提倡这个方法，文章中很少遇到。） 为了使被说明对象更形象、具体，可以进行状貌摹写，这种说明方法叫摹状貌。（和描写要区分开，两者虽一样，不过是在不同的文体中的。） 8.引言论/引用/引资料
商品说明书写作方法 (1)商品说明书的概念 商品说明书是一种以说明为主要表达方式,概括介绍商品用途、性能、特征、使用和保管方法等知识的文章。 (2)商品说明书的结构及写作方法 ①概说 商品说明书的开头部分常常用概说的方法简要地阐明其性质特点,有的甚至全文都用概说的方法。 概说,就是抓住事物的主要特征或主要情况,进行简明扼要的交代和简要概括的说明。 ②陈述 陈述就是根据事物需要说明的顺序,有条理地说出来。但叙述的目的不是为了表现过程,而是说明方法。陈述的写作必须立足于消费者一方,从方便顾客和使用安全等方面着想,尽可能考虑一些在使用过程可能发生的问题,作比较详尽的介绍。过程的陈述需要达到什么程度,是根据商品的性质和消费者使用的具体情况决定的。如果所要说明的方法比较复杂,商品价值比较昂贵、危险性比较大,或者比较容易损坏等,消费者需要了解它们的操作或使用过程,作者就应该加以详尽的陈述,甚至加有说明的图画、照片,使消费者一看便清楚。这种增强消费者信赖感和安全感的方
法,其实也在增强了产品的竞争能力。 ③解说 解说作为商品说明的主要方法,是由商品说明书的特性所决定的。商品说明书是向读者引荐商品的媒介,就必须要解说,侧重于对事物的性质、特征、功用、方法诸方法的讲解。 由于各种产品的功能、用法不同,写作方法自然也大有区别,但不管使用哪一种方法,其目的都是为了读者明白。因此,商品说明书的写作语言必须力求通俗、准确;结构必须条理、有序。原则上说明书结构的安排主要有以下两种: a.根据人们认识事物的先后顺序安排结构; b.根据事物特征的内在联系安排结构。 产品说明书例文 浓维生素E胶丸说明书 维生素E是一种对人体生长、发育、促进健康与预防衰老有关的营养要素。早在1992年Evens等已发现它的功能,可调节生育机能,防治流产和不育。半个世纪以来,就生理和机理作用,近代分子生物学学者作了详尽研究,在营养及医疗上有了重要发现。 1.本品能促进人体能量代谢,增强人的体质和活力: 2.本品能预防因多不饱和脂肪酸(PuFA)异常氧化所致的有害物质积累而损伤正常组织引起的早衰,有延迟衰老的
产品说明书的写法 作者:未知来自:百度贴吧点击: 12566 时间:2007-5-29 （一）产品说明书概述 产品说明书，是对商品的性能、用途、使用和保养方法以及注意事项等作书面介绍的文书。产品说明书，又叫商品说明书。产品说明书的作用：助和指导消费者正确地认识商品、使用和保养商品，兼具宣传商品的作用。根据内容和用途的不同：可分为民用产品说明书、专业产品说明书、技术说明书等。根据表达形式的不同：可分为条款式说明书、文字图表说明书等。根据传播方式的不同，可分为：包装式：即直接写在产品的外包装上。内装式：将产品说明书专门印制，甚至装订成册，装在包装箱（盒）内。 （二）产品说明书的特点 ⒈说明性。说明、介绍产品，是主要功能和目的。 ⒉实事求是性。必须客观、准确反映产品。 ⒊指导性。还包含指导消费者使用和维修产品的知识。 ⒋形式多样性。表达形式可以文字式，也可以图文兼备。 （三）产品说明书的结构和写法 ⒈标题。一般是由产品名称加上“说明书”三字构成，如《VCD说明书》。有些说明书侧重介绍使用方法，称为使用说明书，如《吹风机使用说明》。 ⒉正文。通常详细介绍产品的有关知识：产地、原料、功能、特点、原理、规格、使用方法、注意事项、维修保养等知识。不同说明书的内容侧重点也有所不同。一般的产品说明书分为⑴家用电器类。⑵日用生活品类。⑶食品药物类。⑷大型机器设备类。⑸设计说明书。 ⒊附文。厂名、地址、电话、电挂、电传、联系人和生产日期等。出口产品在外包装上写明生产日期、中外文对照。
（四）注意事项： 突出产品特点。要注意广告和说明书的区别。如“喝孔府家酒，做天下文章”可做广告语，写入产品说明书不合适。语言要求准确、通俗、简明。尽可能图文并重。 【案例】 香雪牌抗病毒口服液使用说明书 (纯中药新药) 本品系以板兰根、藿香、连翘、芦根、生地、郁金等中药为原料，用科学方法精心研制而成。是实施新药审批法以来通过的，第一个用于治疗病毒性疾患的纯中药新药。 本品经中山医科大学附属第一医院、第一军医大学南方医院和广州市第二人民医院等单位严格的临床证，证明对治疗上呼吸道炎、支气管炎、流行性出血性结膜炎(红眼病)、腮腺炎等病毒性疾患有显著疗效。总有效率达91．27％。其中，对流行性出血性结膜炎(红眼病)和经病毒分离阳性的上呼吸道炎疗效均为100％，并有明显缩短病程的作用。 本品疗效确切，服用安全、方便，尤其适用于儿童患者，是治疗病毒性疾病的理想药物。 [性状]本品为棕红色液体，味辛，微苦。 [功能与主治]抗病毒药。功效清热祛湿，凉血解毒，用于治疗风热感冒、瘟病发热及上呼吸道感染、流感、腮腺炎等病毒感染疾患。 [用法与用量]口服，一次10ml，一日2～3次，宜饭后服用，小儿酌减。 [注意事项]临床症状较重，病程较长或合并有细菌感染的患者应加服其他治疗药物。 [规格]每支10ml。
常见的写作方法、修辞手法、说明方法归类 (2012-03-19 23:22:00) 转载▼ 标签： 分类：教学之路 教育 常见的写作方法有： 悬念、照应、联想、想象、抑扬结合、点面结合、动静结合、叙议结合、情景交融、首尾呼应（也叫前后呼应）、衬托对比、伏笔照应、托物言志、白描细描、铺垫悬念、正面侧面比喻象征、借古讽今、卒章显志、承上启下、开门见山，烘托、渲染、动静相衬、虚实相生、实写与虚写、托物寓意、咏物抒情等。 常见的修辞手法有： 拟人、比喻、夸张、排比、对偶（古诗词常见，现在不多要求用了) 反问、引用、对比、反复、顶针、比拟、回环、通感、双关、借代、反复等。 常见的说明方法有： 1举例子 举出实际事例来说明事物，使所要说明的事物具体化，以便读者理解，这种说明方法叫举例子。 好处：使文章表达的意思更明确，更生动形象，读者更明白，增强说服力。更具体、更详细。 2作引用 为了使说明的内容更充实具体，可以引用一些文献资料、诗词、俗语、名人名言等，可使说明更具说服力。 好处：使文章更具说服力。体现说明文语言的准确性。引用古诗：使说明文更具诗情画意。 3作比较
作比较是将两种类别相同或不同的事物、现象加以比较来说明事物特征的说明方法。说明某些抽象的或者是人们比较陌生的事物，可以用具体的或者大家已经熟悉的事物和它比较，使读者通过比较得到具体而鲜明的印象。事物的特征往往在比较中显现出来。在作比较的时候，可以是同类相比，也可以是异类相比，可以对事物进行“横比”也可以对事物进行“纵比”。 好处：突出强调被说明对象的特点（地位、影响等）。 4列数字（列数据） 为了使所要说明的事物具体化，还可以采用列数字的方法，以便读者理解。需要注意的是，引用的数字，一定要准确无误，不准确的数字绝对不能用，即使是估计的数字也要有可靠的根据，并力求近 似。 好处：数字是从数量上说明事物特征或事理的最精确、最科学、最有说服力的依据。（用列数字的方法进行说明，既能准确客观的反映事实情况，又有较强的说服力。）准确无误，令读者信服。 5分类别 要说明事物的特征，往往从单方面不易说清楚，可以根据形状、性质、成因、功用等属性的异同，把事物分成若干类，然后依照类别逐一加以说明。这种说明方法，叫分类别。分类别是将复杂的事物说清楚的重要方法，有时事物的特征、本质需要分成几点或几个方面来说明，也属分类别。 好处：条理清晰，一目了然。 6打比方 利用两种不同事物之间的相似之处作比较，以突出事物的性状特点，增强说明的形象性和生动性的说明方法叫做打比方。 说明文中的打比方的说明方法，同修辞格上的比喻还有联想是一致的。不同的是，比喻修辞有明喻、暗喻、和借喻，而说明多用明喻和暗喻，借喻则不宜使用。 好处：抽象的事理变得具体、生动、形象。（或把事物的特征解说得确切具体、浅显易懂。） 7摹状貌
{产品名称} 软件需求规格说明书 编写人： 编写日期：年月日
目录 1.产品描述 (3) 1.1.编写目的 (3) 1.2.产品名称 (3) 1.3.名词定义（可选） (3) 2.产品需求概述 (3) 2.1.功能简介 (3) 2.2.运行环境 (3) 2.3.条件与限制（可选） (3) 3.功能需求 (3) 3.1.功能划分（可选） (3) 3.2.功能1 (4) 3.3.功能N (4) 3.4.不支持的功能 (4) 4.数据描述 (4) 5.性能需求（可选） (4) 6.运行需求（可选） (4) 6.1.用户界面 (4) 6.2.硬件接口 (4) 6.3.软件接口 (5) 6.4.通信接口 (5) 7.其它需求（可选） (5) 8.特殊需求（可选） (5) 9.不确定的问题（可选） (5) 10.编写人员及编写日期 (5) 11.附录 (5) 11.1.引用文件 (5) 11.2.参考资料 (5)
1.产品描述 1.1.编写目的 【说明编写本软件需求规格说明书的目的，指出预期的读者。】 1.2.产品名称 【本项目的名称，包括项目的全名、简称、代号、版本号。】 1.3.名词定义（可选） 【对重要的或是具有特殊意义的名词（包括词头和缩写）进行定义，以便读者可以正确地解释软件需求说明。】 2.产品需求概述 2.1.功能简介 【对产品的基本功能做一个简介，包括： 1.本产品的开发意图、应用目标及作用范围。 2．概略介绍了产品所具有的主要功能。可以用列表的方法给出，也可以用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图等。 3．说明本产品与其他相关产品的关系，是独立产品还是一个较大产品的组成部分。 可以用表示外部接口和数据流的系统高层次图，或者方框图说明。】 2.2.运行环境 1.硬件环境： 【详细列出本软件运行时所必须的最低硬件配置、推荐硬件配置(如主机、显示器、外部设备等)以及其它特殊设备。】 2.软件环境： 【如操作系统、网络软件、数据库系统以及其它特殊软件要求。】 2.3.条件与限制（可选） 【说明本软件在实现时所必须满足的条件和所受的限制，并给出相应的原因。 必须满足的条件包括输入数据的范围以及格式。 所受的限制包括软件环境、硬件环境等方面的内容。例如：必须使用或者避免的特定技术、工具、编程语言和数据库；企业策略、政府法规或工业标准；硬件限制，例如定时需求或存储器限制；经费限制、开发期限；项目对外部因素存在的依赖。例如其它项目开发的组件。等等】 3.功能需求 【功能需求描述系统特性，即产品所提供的主要服务。可以通过使用实例、运行模式、用户类、对象类或功能等级等不同方法来描述，还可以把它们组合起来使用。 功能需求的表述形式可以参见《需求分析和管理指南》第8.2节。】 3.1.功能划分（可选） 【此部分从用户的角度描述将软件划分成不同的部分，并给出总体功能结构。对于复杂
创业计划书写作指南 创业计划大赛要求参赛者组成优势互补的竞赛小组，提出并围绕一个具有市场前景的产品、技术、概念产品或服务，完成一份深入、具体、完整的创业计划，以描述公司的创业机会，阐述创立公司、把握这一机会的进程，说明所需要的资源，揭示风险和预期回报，并提出行动建议。创业计划聚焦于特定的策略、目标、计划和行动，对于一个非技术背景的有兴趣的人士应清晰易懂。创业计划可能的读者包括：希望吸纳进入团队的对象，可能的投资人、合作伙伴、供应商、顾客、政策机构等。 创业计划书的组成部分（顺序和内容仅供参考） 创业计划一般包括：执行总结、产业背景、市场调查和分析、公司战略、营销策略、经营管理、管理团队、融资与资金运营计划、财务分析与预测、关键的风险和问题等十个方面。 一、执行总结 是创业计划一到两页的概括，包括以下方面： 1、公司及提供的产品、技术、概念产品或服务的概述 2、面临的市场机会和目标市场定位与预测 3、市场环境和竞争优势 4、经济状况和盈利能力预测 5、团队概述 6、所需资源，提供的利益等 二、产业背景和市场竞争
1、本创业计划的产业背景和市场竞争环境 2、详细的产品、技术、概念产品或服务说明，以及如何满足关键的顾客需求 三、市场调查和分析 1、目标市场的定位与分析 2、市场容量估算和趋势预测 3、竞争分析和竞争优势 4、估计的市场份额和销售额 5、市场发展的趋势等 四、公司战略 阐释公司的发展战略，分阶段制定公司的发展计划与目标，包括： 1、商业模式 2、总体进度安排、分阶段制定公司的发展计划与市场目标 3、公司的研发方向和产品线扩张策略 4、主要的合作伙伴与竞争对手等 五、营销策略 制定有效的营销策略，确保产品顺利进入市场，并保持和提高市场占有率，包括： 1、定义产品、技术、概念产品或服务面对的顾客群，所提供的核心价值、附加利益等 2、制定符合本项目市场特点的价格策略 3、构建通畅合理的营销渠道 4、提出新颖而富于吸引力的推广策略
约定 按钮：统一风格，用【按钮名称】标识 例如：单击【确定】 多级菜单及模块：统一风格，多级菜单项用/分隔 例如：打开“文件/保存”菜单项；单击“员工管理/查询浏览/信息浏览” 调用CS插件，统一改为：调用插件，去掉CS Excel、Word，统一大小字Excel、Word 排版中有几个样式需要统一 一、章节 第一章标题1 章的格式为： 字体：一号、黑体、居中 段落：缩进：左侧0 字符、右侧0 字符、特殊格式为无 间距：段前20 磅、段后20 磅 行距：2倍行距 1
如果定义了文档网格，则向网络对格。 第1节标题2 节的格式： 字体：二号、宋体、加粗、居中 段落：缩进：左右为0、无特殊格式 间距：段前10 磅、段后10 磅 行距：两倍行距 如果定义了文档网格，则向网络对格。 1.1标题3 字体：三号、宋体、加粗、两端对齐 段落：缩进：左右为0、无特殊格式 间距：段前10 磅、段后10 磅 行距：单倍行距 1.1.1标题4 字体：小三号、宋体、加粗、两端对齐 段落：缩进：左右为0、无特殊格式 间距：段前10 磅、段后10 磅 2
行距：单倍行距 如果定义了文档网络，则对网络对齐。 1.1.1.1标题5 字体：四号、宋体、加粗、两端对齐 段落：缩进；左右为0、无特殊格式； 间距：段前6、段后；6、单倍行距； 标题和前面的序号之间加上一个空格 二、正文内容： 字体：五号、宋体 段落：缩进：左右为0， 特殊格式：首行缩进2字符 段落间距：最小值16磅 标点符号注意中英状态。 三、页面设置 页边距：上下2.5厘米、左右1.5厘米 纸张：宽18厘米、高24.5厘米 版式；奇偶页不同、页眉1.5厘米、页脚1.75厘米 3
商品说明书范文 1．客观性。 2．实用性。 3．条理性。 4．通俗性。 1．以内容为标准，说明书可以分为解说阐述性说明书和介绍简述性说明书。 2．以篇幅的长短为标准，说明书可以分为完整性说明书和简约性说明书。 3．以表达的形式为标准，说明书可以分为文字式说明书，图表式说明书和音像式说明书。 结构 （一）标题 2．以商品名称作标题。例如《三九胃泰》、《紫光扫描仪》等。 3．以商品名称加文种作标题。例如《盖中盖口服液产品说明书》、《步步高DVD使用说明书》等。（二）正文 一般情况包括以下几个方面的内容： 1．产品的概况(如名称、产地、规格、发展史、制作方法等)。 2．产品的性能、规格、用途。 3．安装和使用方法。 4．保养和维修方法。 5．附件、备件及其它需要说明的内容。
以上的内容，可以根据实际需求取舍详略和变动前后顺序。正文的写法有多种多样，常用写法如说明文式、条文式、对话式、表格式、故事式、解释式等，比较常见的有概述式、短文式、条款式、图文结合式。 1．概述式。一般只有一两段文字，简明扼要地对商品作概括介绍。 2．短文式。对商品的性质、性能、特征、用途和使用方法作简要介绍，多用于介绍性的内容说明，常用商品多采用这种方法。 3．条款式。这是详细介绍商品的说明书的写法。它分成若干个部分，将有关商品的规格、构造、主要性能和指标参数、保养方法、维修保修方式更逐一分条列项介绍给消费者。常用的家用电器说明书多采用这种方式。 4．图文综合式。即图文并茂地介绍商品。既有详尽的文字说明，又有照片和图示解说，辅之一电路图、构造图、分子式（医药）等等。这种商品的说明书往往印成小册子作为商品附件。 专利说明书有广义和狭义两种解释。就广义而言，专利说明书是指各国专利局或国际性专利组织出版的各种类型说明书的统称。包括未经过专利性审查的申请说明书，如德国公开说明书、日本公开特许公报，中国发明专利申请公开说明书等;以及经过专利性审查的专利说明书，如美国专利说明书、前苏联发明说明书、中国发明专利说明书等。 就狭义而言，专利说明书是指经过专利性审查、授予专利权的专利说明书。
第四单元写作使用恰当的说明方法 写作导引 要说明一个事物或说明一种道理，就要讲究说明方法。说明的方法多种多样，有打比方、分类别、列数字、下定义、引资料、作比较、绘图表等。选择恰当的说明方法，可以将事物或事理说明得更 清楚，更准确，使文章更具有科学性。 看看下面各句运用了什么说明方法，体会这些说明方法的表达效果。 我国的诗人爱把拱桥比作虹，说拱桥是“卧虹”“飞虹”，把水上拱桥形容为“长虹卧波”。 图书馆的藏书，按国别分，有中国的、外国的；按时代分，有古典的、现代的；按性质分，有科技 的、文学的以及政治经济方面的?? 冬季南北温度悬殊，夏季却相差不大。在春天，早春跟晚春也不相同。如在早春三四月间，南京桃花要比北京早开20天，但是到晚春五月初，南京刺槐开花只比北京早10天。 下面提示几种重要的说明方法，或许有助于你写好说明文。 第一，打比方。说明大家陌生的事物时，打个比方，能让读者更容易明白；说明大家并不陌生的事物时，为了增强表达效果，也可以打个比方。例如《中国石拱桥》开篇说：“石拱桥的桥洞成弧形，就像虹。”通过“虹”的比方，让人在脑海里马上产生石拱桥的大概形象。 第二，分类别。写事物说明文，先想好事物有哪几个方面的特点，再加以说明；写事理说明文，先想好用哪些食物或现象来说明这个科学道理。《看云识天气》这篇事物说明文写天上的云，从大的方面分为晴天的“薄云”和阴雨天“低而厚密的云层”，其中“薄云”又分为“卷云”“卷积云”“积云” 和“高积云”等。这样分类，是不是给读者以清晰的印象？ 第三，列数字。说明文为了准确地说明事物，常常用数字说话。这种数字应该是精准无误的，不能凭空想象或估算；如果不能确定其数字，应该加上“大约”“左右”等词。例如《故宫博物院》介绍 故宫宏观布局时使用了不少数字，把这 些说明得文字找出来，体会文章的科学性、严谨性。 第四，下定义。就是抓住事物或事理最重要、最本质的特征来说明，所说明得内容应该是周全的，所用的语句应该是精准、简明的。《看云识天气》中有较多的下定义的语句，例如说明“晕”：“在太阳和月亮的周围，有时会出现一种美丽的七彩光圈，里层是红色的，外层是紫色的。这种光圈叫做晕。”设想一下，如果只提“太阳”，或不提“有时”，说明得效果会怎样？ 第五，引资料。为了让说明的内容更加丰富、充实，可以适当地引用一些资料，如名人著述、公式定律、谚语、典故等。例如《中国石拱桥》引用《水经注》的话，推断“旅人桥”是有记录的最早的石拱桥；引用意大利人马可·波罗的游记的话，说明卢沟桥的“独一无二”“闻名世界”。 写作实践 一制作图表也是说明事物时常用到的方法。阅读下面关于“中国古代桥梁之最”的材料，在表格中 填写相关内容，并说说制作图表的好处。 现存最古老的敞肩拱石桥是河北赵县的赵州桥，隋开皇十五年至大业元年（595～605年）建；现存最早的也是桥洞最多的联拱石桥是江苏苏州的宝带桥，唐元和十一年（816年）始建；现存最早的十字桥是山西晋祠鱼沼飞梁，北宋崇宁元年（1102年）建；最早的开关活动式大石桥是广州潮州广 济桥，明宣德十年（1435年）建。 【提示】 1.摘录字词和数字要准确无误，写后检查一遍。 2.填写“桥梁特点”时要注意语言简练，可以摘录要点。 3.将图表与上面的说明文字进行对比，体会列图表说明的好处。
代码编写规范说明书（c#.net与https://www.doczj.com/doc/d916020781.html,）目录 1 目的 2 范围 3 注释规范 3.1 概述 3.2 自建代码文件注释 3.3 模块（类）注释 3.4 类属性注释 3.5 方法注释 3.6 代码间注释 4 命名总体规则 5 命名规范 5.1 变量（Variable）命名 5.2 常量命名 5.3 类（Class）命名 5.4 接口（Interface）命名 5.5 方法（Method）命名 5.6 名称空间Namespace）命名 6 编码规则 6.1 错误检查规则 6.2 大括号规则 6.3 缩进规则 6.4 小括号规则 6.5 If Then Else规则 6.6 比较规则 6.7 Case规则 6.8 对齐规则 6.9 单语句规则 6.10 单一功能规则 6.11 简单功能规则 6.12 明确条件规则 6.13 选用FALSE规则 6.14 独立赋值规则 6.15 定义常量规则 6.16 模块化规则 6.17 交流规则 7 编程准则 7.1 变量使用 7.2 数据库操作 7.3 对象使用 7.4 模块设计原则 7.5 结构化要求 7.6 函数返回值原则 8 代码包规范 8.1 代码包的版本号
8.2 代码包的标识 9 代码的控制 9.1 代码库/目录的建立 9.2 代码归档 10 输入控制校验规则 10.1 登陆控制 10.2 数据录入控制 附件1：数据类型缩写表 附件2：服务器控件名缩写表 1 目的 一.为了统一公司软件开发设计过程的编程规范 二.使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义 三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作 2 范围 本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 3 注释规范 3.1 概述 a) 注释要求英文及英文的标点符号。 b) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。 c) 每行注释的最大长度为100个字符。 d) 将注释与注释分隔符用一个空格分开。 e) 不允许给注释加外框。 f) 编码的同时书写注释。 g) 重要变量必须有注释。 h) 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。 如：int m_iLevel,m_iCount; // m_iLevel ....tree level // m_iCount ....count of tree items string m_strSql; //SQL i) 典型算法必须有注释。 j) 在循环和逻辑分支地方的上行必须就近书写注释。 k) 程序段或语句的注释在程序段或语句的上一行 l) 在代码交付之前，必须删掉临时的或无关的注释。 m) 为便于阅读代码，每行代码的长度应少于100个字符。 3.2 自建代码文件注释 对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释： /****************************************************** FileName: Copyright (c) 2004-xxxx *********公司技术开发部 Writer: create Date: Rewriter: