硬件开发流程及规范

1、硬件开发流程及规范第一章 概述第一节 硬硬件开发发过程简简介1.1.1 硬硬件开发发的基本本过程硬件开发的的基本过过程：1.明确硬硬件总体体需求情情况，如如CPUU 处理理能力、存存储容量量及速度度，I/O 端端口的分分配、接接口要求求、电平平要求、特特殊电路路（厚膜膜等）要要求等等等。2.根据需需求分析析制定硬硬件总体体方案，寻寻求关键键器件及及电咱的的技术资资料、技技术途径径、技术术支持，要要比较充充分地考考虑技术术可能性性、可靠靠性以及及成本控控制，并并对开发发调试工工具提出出明确的的要求。关关键器件件索取样样品。3.总体方方案确定定后，作作硬件和和单板软软件的详详细设计计，包括括绘制硬

2、硬件原理理图、单单板软件件功能框框图及编编码、PPCB 布线，同同时完成成发物料料清单。4.领回PPCB 板及物物料后由由焊工焊焊好12 块单单板，作作单板调调试，对对原理设设计中的的各功能能进行调调测，必必要时修修改原理理图并作作记录。5.软硬件件系统联联调，一一般的单单板需硬硬件人员员、单板板软件人人员的配配合，特特殊的单单板（如如主机板板）需比比较大型型软件的的开发，参参与联调调的软件件人员更更多。一一般地，经经过单板板调试后后在原理理及PCCB布线线方面有有些调整整，需第第二次投投板。6.内部验验收及转转中试，硬硬件项目目完成开开发过程程。1.1.2 硬硬件开发发的规范范化硬件开发的的

3、基本过过程应遵遵循硬件件开发流流程规范范文件执执行，不不仅如此此，硬件件开发涉涉及到技技术的应应用、器器件的选选择等，必必须遵照照相应的的规范化化措施才才能达到到质量保保障的要要求。这这主要表表现在，技技术的采采用要经经过总体体组的评评审，器器件和厂厂家的选选择要参参照物料料认证部部的相关关文件，开开发过程程完成相相应的规规定文档档，另外外，常用用的硬件件电路（如如ID.WDTT）要采采用通用用的标准准设计。第二节 硬硬件工程程师职责责与基本本技能1.2.1 硬硬件工程程师职责责一个技术领领先、运运行可靠靠的硬件件平台是是公司产产品质量量的基础础，硬件件工程师师职责神神圣，责责任重大大。1、硬

4、件工工程师应应勇于尝尝试新的的先进技技术，在在产品硬硬件设计计中大胆胆创新。2、坚持采采用开放放式的硬硬件架构构，把握握硬件技技术的主主流和未未来发展展，在设设计中考考虑将来来的技术术升级。3、充分利利用公司司现有的的成熟技技术，保保持产品品技术上上的继承承性。4、在设计计中考虑虑成本，控控制产品品的性能能价格比比达至最最优。5、技术开开放，资资源共享享，促进进公司整整体的技技术提升升。1.2.1 硬硬件工程程师基本本素质与与技术硬件工程师师应掌握握如下基基本技能能：1、由需求求分析至至总体方方案、详详细设计计的设计计创造能能力；2、熟练运运用设计计工具，设设计原理理图、EEPLDD、FPGG

5、A 调调试程序序的能力力；3、运用仿仿真设备备、示波波器、逻逻辑分析析仪调测测硬件的的能力；4、掌握常常用的标标准电路路的设计计能力，如如ID 电路、WWDT 电路、型滤波波电路、高高速信号号传输线线的匹配配电路等等；5、故障定定位、解解决问题题的能力力；6、文档的的写作技技能；7、接触供供应商、保保守公司司机密的的技能。第二章 硬硬件开发发规范化化管理第一节 硬硬件开发发流程3.1.1 硬硬件开发发流程文文件介绍绍硬件开发的的规范化化是一项项重要内内容。硬硬件开发发规范化化管理是是在公司司的硬硬件开发发流程及及相关的的硬件件开发文文档规范范、PCB 投板流程等文件中规划的。硬件开发流流程是指

6、指导硬件件工程师师按规范范化方式式进行开开发的准准则，规规范了硬硬件开发发的全过过程。硬硬件开发发流程制制定的目目的是规规范硬件件开发过过程控制制，硬件件开发质质量，确确保硬件件开发能能按预定定目的完完成。硬件开发流流程不但但规范化化了硬件件开发的的全过程程，同时时也从总总体上，规规定了硬硬件开发发所应完完成的任任务。做做为一名名硬件工工程师深深刻领会会硬件开开发流程程中各项项内容，在在日常工工作中自自觉按流流程办事事，是非非常重要要的。所所有硬件件工程师师应把学学流程、按按流程办办事、发发展完善善流程、监监督流程程的执行行作为自自己的一一项职责责，为公公司的管管理规范范化做出出的贡献献。3.

7、2.2 硬硬件开发发流程详详解硬件开发流流程对硬硬件开发发的全过过程进行行了科学学分解，规规范了硬硬件开发发的五大大任务。硬件需求分分析硬件系统设设计硬件开发及及过程控控制系统联调文档归档及及验收申申请。1. 硬件件需求分分析项目组接到到任务后后，首先先要做的的硬件开开发工作作就是要要进行硬硬件需求求分析，撰撰写硬件件需求规规格说明明书。硬硬件需求求分析在在整个产产品开发发过程中中是非常常重要的的一环，硬硬件工程程师更应应对这一一项内容容加以重重视。一一项产品品的性能能往往是是由软件件和硬件件共同完完成的，哪哪些是由由硬件完完成，哪哪些是由由软件完完成，项项目组必必须在需需求时加加以细致致考虑

8、。硬件需求分分析主要要有下列列内容： 系统统工程组组网及使使用说明明 基本本配置及及其互连连方法 运行行环境 硬件件系统的的基本功功能和主主要性能能指标 功能能模块的的划分 关键键技术的的攻关 外购购硬件的的名称型型号、生生产单位位、主要要技术指指标 主要要仪器设设备 可靠靠性、稳稳定性、电电磁兼容容讨论 电源源、工艺艺结构设设计 硬件件测试方方案2.硬件总总体设计计硬件总体设设计的主主要任务务就是从从总体上上进一步步划分各各单板的的功能以以及硬件件的总体体结构描描述，规规定各单单板间的的接口及及有关的的技术指指标。硬硬件总体体设计主主要有下下列内容容： 系统统功能及及功能指指标 系统统总体结

9、结构图及及功能划划分 单板板命名 系统统逻辑框框图 组成成系统各各功能块块的逻辑辑框图，电电路结构构图及单单板组成成 单板板逻辑框框图和电电路结构构图 关键键技术讨讨论 关键键器件从上可见，硬硬件开发发总体方方案把整整个系统统进一步步具体化化。硬件件开发总总体设计计是最重重要的环环节之一一。总体体设计不不好，可可能出现现致命的的问题，造造成的损损失有许许多是无无法挽回回的。3. 硬件件开发及及过程控控制。一个好的产产品，特特别是大大型复杂杂产品，总总体方案案进行反反复论证证是不可可缺少的的。只有有经过多多次反复复论证的的方案，才才可能成成为好方方案。总体审查包包括两部部分，一一是对有有关文档档

10、的格式式，内容容的科学学性，描描述的准准确性以以及详简简情况进进行审查查。再就就是对总总体设计计中技术术合理性性、可行行性等进进行审查查。如果果评审不不能通过过，项目目组必须须对自己己的方案案重新进进行修订订。硬件总体设设计方案案通过后后，即可可着手关关键器件件的申购购，主要要工作由由项目组组来完成成。关键键器件落落实后，即即要进行行结构电电源设计计、单板板总体设设计。单板总体设设计需要要项目与与CADD 配合合完成。单单板总体体设计过过程中，对对电路板板的布局局、走线线的速率率、线间间干扰以以及EMMI 等等的设计计应与CCAD 室合作作。CAAD 室室可利用用相应分分析软件件进行辅辅助分析

11、析。单板板总体设设计完成成后，出出单板总总体设计计方案书书。总体体设计主主要包括括下列内内容： 单板板在整机机中的的的位置：单板功功能描述述 单板板尺寸 单板板逻辑图图及各功功能模块块说明 单板板软件功功能描述述 单板板软件功功能模块块划分 接口口定义及及与相关关板的关关系 重要要性能指指标、功功耗及采采用标准准 开发发用仪器器仪表等等每个单板都都要有总总体设计计方案，且且要经过过总体办办和管理理办的联联系评审审。否则则要重新新设计。只只有单板板总体方方案通过过后，才才可以进进行单板板详细设设计。单板详细设设计包括括两大部部分： 单板板软件详详细设计计 单板板硬件详详细设计计单板软、硬硬件详细

12、细设计，要要遵守公公司的硬硬件设计计技术规规范，必必须对物物料选用用，以及及成本控控制等上上加以注注意。不同的单板板，硬件件详细设设计差别别很大。但但应包括括下列部部分：单板整体功功能的准准确描述述和模块块的精心心划分。接口的详细细设计。关键元器件件的功能能描述及及评审，元元器件的的选择。符合规范的的原理图图及PCCB 图图。对PCB 板的测测试及调调试计划划。单板详细设设计要撰撰写单板板详细设设计报告告。详细设计报报告必须须经过审审核通过过。单板板软件的的详细设设计报告告由管理理办组织织审查，而而单板硬硬件的详详细设计计报告，则则要由总总体办、管管理办、CAD 室联合进行审查，如果审查通过，

13、方可进行PCB 板设计，如果通不过，则返回硬件需求分析处，重新进行整个过程。这样做的目的在于让项目组重新审查一下，某个单板详细设计通不过，是否会引起项目整体设计的改动。如单板详细细设计报报告通过过，项目目组一边边要与计计划处配配合准备备单板物物料申购购，一方方面进行行PCBB 板设设计。PPCB 板设计计需要项项目组与与CADD 室配配合进行行，PCCB 原原理图是是由项目目组完成成的，而而PCBB 画板板和投板板的管理理工作都都由CAAD 室室完成。PCB投板有专门的PCB 样板流程。PCB 板设计完成后，就要进行单板硬件过程调试，调试过程中要注意多记录、总结，勤于整理，写出单板硬件过程调试

14、文档。当单板调试完成，项目组要把单板放到相应环境进行单板硬件测试，并撰写硬件测试文档。如果PCB 测试不通过，要重新投板，则要由项目组、管理办、总体办、CAD 室联合决定。4. 系统统联调在结构电源源，单板板软硬件件都已完完成开发发后，就就可以进进行联调调，撰写写系统联联调报告告。联调调是整机机性能提提高，稳稳定的重重要环节节，认真真周到的的联调可可以发现现各单板板以及整整体设计计的不足足，也是是验证设设计目的的是否达达到的唯唯一方法法。因此此，联调调必须预预先撰写写联调计计划，并并对整个个联调过过程进行行详细记记录。只只有对各各种可能能的环节节验证到到才能保保证机器器走向市市场后工工作的可可

15、靠性和和稳定性性。联调调后，必必须经总总体办和和管理办办，对联联调结果果进行评评审，看看是不是是符合设设计要求求。如果果不符合合设计要要求将要要返回去去进行优优化设计计。如果联调通通过，项项目要进进行文件件归档，把把应该归归档的文文件准备备好，经经总体办办、管理理办评审审，如果果通过，才才可进行行验收。总之，硬件件开发流流程是硬硬件工程程师规范范日常开开发工作作的重要要依据，全全体硬件件工程师师必须认认真学习习。第二节 硬硬件开发发文档规规范2.2.1 硬硬件开发发文档规规范文件件介绍为规范硬件件开发过过程中文文档的编编写，明明确文档档的格式式和内容容，规定定硬件开开发过程程中所需需文档清清单

16、，与与硬件件开发流流程对对应制定定了硬硬件开发发文档编编制规范范。开开发人员员在写文文档时往往往会漏漏掉一些些该写的的内容，编编制规范范在开发发人员写写文档时时也有一一定的提提示作用用。规范范中共列列出以下下文档的的规范：硬件需求说说明书硬件总体设设计报告告单板总体设设计方案案单板硬件详详细设计计单板软件详详细设计计单板硬件过过程调试试文档单板软件过过程调试试文档单板系统联联调报告告单板硬件测测试文档档硬件信息库库这些规范的的具体内内容可在在HUAAWEII 服务务器中资资料库中中找到，对对应每个个文档规规范都有有相应的的模板可可供开发发人员在在写文档档时“填空”使用。2.2.2 硬硬件开发发

17、文档编编制规范范详解1、硬件需需求说明明书硬件需求说说明书是是描写硬硬件开发发目标，基基本功能能、基本本配置，主主要性能能指标、 运行环境，约束条件以及开发经费和进度等要求，它的要求依据是产品规格说明书和系统需求说明书。它是硬件总体设计和制订硬件开发计划的依据，具体编写的的内容有有：硬件件整体系系统的基基本功能能和主要要性能指指标、硬硬件分系系统的基基本功能能和主要要性能指指标以及及功能模模块的划划分等。2、硬件总总体设计计报告硬件总体设设计报告告是根据据需求说说明书的的要求进进行总体体设计后后出的报报告，它它是硬件件详细设设计的依依据。编编写硬件件总体设设计报告告应包含含以下内内容：系统总体

18、结结构及功功能划分分，系统统逻辑框框图、组组成系统统各功能能模块的的逻辑框框图，电电路结构构图及单单板组成成，单板板逻辑框框图和电电路结构构图，以以及可靠靠性、安安全性、电电磁兼容容性讨论论和硬件件测试方方案等。3、单板总总体设计计方案在单板的总总体设计计方案定定下来之之后应出出这份文文档，单单板总体体设计方方案应包包含单板板版本号号，单板板在整机机中的位位置、开开发目的的及主要要功能，单单板功能能描述、单单板逻辑辑框图及及各功能能模块说说明，单单板软件件功能描描述及功功能模块块划分、接接口简单单定义与与相关板板的关系系，主要要性能指指标、功功耗和采采用标准准。4、单板硬硬件详细细设计在单板硬

19、件件进入到到详细设设计阶段段，应提提交单板板硬件详详细设计计报告。在在单板硬硬件详细细设计中中应着重重体现：单板逻逻辑框图图及各功功能模块块详细说说明，各各功能模模块实现现方式、地地址分配配、控制制方式、接接口方式式、存贮贮器空间间、中断断方式、接接口管脚脚信号详详细定义义、时序序说明、性性能指标标、指示示灯说明明、外接接线定义义、可编编程器件件图、功功能模块块说明、原原理图、详详细物料料清单以以及单板板测试、调调试计划划。有时时候一块块单板的的硬件和和软件分分别由两两个开发发人员开开发，因因此这时时候单板板硬件详详细设计计便为软软件设计计者提供供了一个个详细的的指导，因因此单板板硬件详详细设

20、计计报告至至关重要要。尤其其是地址址分配、控控制方式式、接口口方式、中中断方式式是编制制单板软软件的基基础，一一定要详详细写出出。5、单板软软件详细细设计在单板软件件设计完完成后应应相应完完成单板板软件详详细设计计报告，在在报告中中应列出出完成单单板软件件的编程程语言，编编译器的的调试环环境，硬硬件描述述与功能能要求及及数据结结构等。要要特别强强调的是是：要详详细列出出详细的的设计细细节，其其中包括括中断、主主程序、子子程序的的功能、入入口参数数、出口口参数、局局部变量量、函数数调用和和流程图图。在有有关通讯讯协议的的描述中中，应说说明物理理层，链链路层通通讯协议议和高层层通讯协协议由哪哪些文

21、档档定义。6、单板硬硬件过程程调试文文档开发过程中中，每次次所投PPCB 板，工工程师应应提交一一份过程程文档，以以便管理理阶层了了解进度度，进行行考评，另另外也给给其他相相关工程程师留下下一份有有参考价价值的技技术文档档。每次次所投PPCB 板时应应制作此此文档。这这份文档档应包括括以下内内容：单单板硬件件功能模模块划分分，单板板硬件各各模块调调试进度度，调试试中出现现的问题题及解决决方法，原原始数据据记录、系系统方案案修改说说明、单单板方案案修改说说明、器器件改换换说明、原原理图、PCB 图修改说明、可编程器件修改说明、调试工作阶段总结、调试进展说明、下阶段调试计划以及测试方案的修改。7、

22、单板软软件过程程调试文文档每月收集一一次单板板软件过过程调试试文档，或或调试完完毕（指指不满一一月）收收集，尽尽可能清清楚，完完整列出出软件调调试修改改过程。单单板软件件过程调调试文档档应当包包括以下下内容：单板软软件功能能模块划划分及各各功能模模块调试试进度、单单板软件件调试出出现问题题及解决决、下阶阶段的调调试计划划、测试试方案修修改。8、单板系系统联调调报告在项目进入入单板系系统联调调阶段，应应出单板板系统联联调报告告。单板板系统联联调报告告包括这这些内容容：系统统功能模模块划分分、系统统功能模模块调试试进展、系系统接口口信号的的测试原原始记录录及分析析、系统统联调中中出现问问题及解解决

23、、调调试技巧巧集锦、整整机性能能评估等等。9、单板硬硬件测试试文档在单板调试试完之后后，申请请内部验验收之前前，应先先进行自自测以确确保每个个功能都都能实现现，每项项指标都都能满足足。自测测完毕应应出单板板硬件测测试文档档，单板板硬件测测试文档档包括以以下内容容：单板板功能模模块划分分、各功功能模块块设计输输入输出出信号及及性能参参数、各各功能模模块测试试点确定定、各测测试参考考点实测测原始记记录及分分析、板板内高速速信号线线测试原原始记录录及分析析、系统统I/OO 口信信号线测测试原始始记录及及分析，整整板性能能测试结结果分析析。10、硬件件信息库库为了共享技技术资料料，我们们希望建建立一个

24、个共享资资料库，每每一块单单板都希希望将的的最有价价值最有有特色的的资料归归入此库库。硬件件信息库库包括以以下内容容：典型型应用电电路、特特色电路路、特色色芯片技技术介绍绍、特色色芯片的的使用说说明、驱驱动程序序的流程程图、源源程序、相相关硬件件电路说说明、PPCB 布板注注意事项项、单板板调试中中出现的的典型及及解决、软软硬件设设计及调调试技巧巧。第三节 与与硬件开开发相关关的流程程文件介介绍与硬件开发发相关的的流程主主要有下下列几个个：项目立项流流程项目实施管管理流程程软件开发流流程系统测试工工作流程程中试接口流流程内部接收流流程3.3.1 项项目立项项流程：是为了加强强立项管管理及立立项

25、的科科学性而而制定的的。其中中包括立立项的论论证、审审核分析析，以期期做到合合理进行行开发，合合理进行行资源分分配，并并对该立立项前的的预研过过程进行行规范和和管理。立立项时，对对硬件的的开发方方案的审审查是重重要内容容。3.3.2 项项目实施施管理流流程：主要定义和和说明项项目在立立项后进进行项目目系统分分析和总总体设计计以及软软硬件开开发和内内部验收收等的过过程和接接口，并并指出了了开发过过程中需需形成的的各种文文档。该该流程包包含着硬硬件开关关、软件件开发、结结构和电电源开发发、物料料申购并并各分流流程。3.3.3 软软件开发发流程：与硬件开发发流程相相对应的的是软件件开发流流程，软软件

26、开发发流程是是对大型型系统软软件开发发规范化化管理文文件，流流程目的的在对软软件开发发实施有有效的计计划和管管理，从从而进一一步提高高软件开开发的工工程化、系系统化水水平，提提高XXXXX 公司软软件产品品质量和和文档管管理水平平，以保保证软件件开发的的规范性性和继承承性。软软件开发发与硬件件结构密密切联系系在一起起的。一一个系统统软件和和硬件是是相互关关联着的的。3.3.4 系系统测试试工作流流程：该流程规定定了在开开发过程程中系统统测试过过程，描描述了系系统测试试所要执执行的功功能，输输入、输输出的文文件以及及有关的的检查评评审点。它它规范了了系统测测试工作作的行为为，以提提高系统统测试的

27、的可控性性，从而而为系统统质量保保证提供供一个重重要手段段。项目立项完完成，成成立项目目组的同同时要成成立对应应的测试试项目组组。在整整个开发发过程中中，测试试可分为为三个阶阶段，单单元测试试、集成成测试、系系统测试试。测试试的主要要对象为为软件系系统。3.3.5 中中试接口口流程中试涉及到到中央研研究部与与中试部部开发全全过程。中中研部在在项目立立项审核核或项目目立项后后以书面面文件通通知中试试部，中中试部以以此来确确定是否否参与该该项目的的测试及及中试准准备的相相关人选选，并在在方案评评审阶段段参与进进来对产产品的工工艺、结结构、兼兼容性及及可生产产性等问问题进行行评审，在在产品开开发的后

28、后期，项项目组将将中试的的相关资资料备齐齐，提交交新产产品准备备中试联联络单，由由业务部部、总体体办、中中研计划划处审核核后，提提交中试试部进行行中试准准备，在在项目内内部验收收后转中中试，在在中试过过程中出出现的中中试问题题，由中中试部书书面通知知反馈给给项目组组，进行行设计调调整直至至中试通通过。由上可见中中试将在在产品设设计到验验收后整整个过程程都将参参与，在在硬件开开发上，也也有许多多方面要要提早与与中试进进行联系系。甚至至中试部部直接参参与有关关的硬件件开发和和测试工程。3.3.6 内内部验收收流程制定的目的的是加强强内部验验收的规规范化管管理，加加强设计计验证的的控制，确确保产品品

29、开发尽尽快进入入中试和和生产并并顺利推推向市场场。项目目完成开开发工作作和文档档及相关关技术资资料后，首首先准备备测试环环境，进进行自测测，并向向总体办办递交系系统测试试报告及及项目验验收申请请表，总总体办审审核同意意项目验验收申请请后，要要求项目目组确定定测试项项目，并并编写测测试项目目手册。测测试项目目手册要要通过总总体办组组织的评评审，然然后才组组成专家家进行验验收。由上可见，硬硬件开发发过程中中，必须须提前准准备好文文档及各各种技术术资料，同同时在产产品设计计时就必必须考虑虑到测试试。附录一. 硬件设设计流程程图：阶段流程图表单硬件需求评估硬件需求分析（包括技术风险评估）硬件需求分析（

30、包括技术风险评估）硬件开发计划和配置管理计划进度计划表硬件开发计划和配置管理计划进度计划表硬件测试计划硬件测试计划硬件需求分分析报告告硬件开发计计划硬件测试计计划硬件详细设计详细硬件设计详细硬件设计LCD认证流程关键器件采购PCB毛坯图设计内部设计评审LCD认证流程关键器件采购PCB毛坯图设计内部设计评审硬件详细设设计说明明书硬件电路原原理图硬件BOMM硬件设计内内部评审审记录硬件实现测试PCB布板流程PCB布板流程软件投板前审查软件投板前审查打样、试产硬件调试打样、试产硬件调试PCB贴片硬件内部评审PCB贴片硬件内部评审整机测试评审后发布并归档硬件修改整机测试评审后发布并归档硬件修改PCB数

31、据据器件规格书书硬件子系统统软件装配图硬件单元测测试分析析报告电装总结报报告硬件系统测测试版本本硬件系统测测试分析析报告硬件评审验验证报告告发布版本参考文件：PCB布板板流程图图LCD认证证流程图图附录二. 软件设设计流程程图：阶段流程图表单软件需求分析软件需求分析（包括技术风险评估）软件需求分析（包括技术风险评估）软件开发计划和配置管理计划进度计划表软件开发计划和配置管理计划进度计划表软件测试计划软件测试计划软件需求规规格书软件开发计计划软件开发风风险控制制计划软件测试计计划软件详细设计详细软件设计详细软件设计内部设计评审内部设计评审软件详细设设计说明明书软件接口设设计说明明书软件设计内内部

32、评审审记录软件实现测试编码调试编码调试编写测试用例单元测试编写测试用例单元测试软件集成/调试软件集成/调试评审后发布并归档软件修订软件系统测试发布系统测试版本评审后发布并归档软件修订软件系统测试发布系统测试版本单元源代码码单元调试报报告单元测试用用例单元测试分分析报告告集成后的软软件及源源代码软件集成调调试报告告软件操作手手册系统测试软软件系统测试用用软件文文档软件系统测测试分析析报告发布版本参考文件：附录三编程程规范单板软件编编程规范范目的：为了了开发人人员之间间更好地地进行交交流，提提高代码码的可读读性，可可维护性性，特制制订本规规范，作作为程序序编写的的指导文文件。本本规范只只涉及到到源

33、码书书写的格格式，希希望能有有较统一一的编程程风格。将将来若有有和公司司相关规规定冲突突的地方方，本规规范有可可能作适适当修改改。1。模块描描述模块是为了了实现某某一功能能的函数数的集合合，文件件名使用用缺省的的后缀，在在每一模模块的开开头应有有如下的的描述体体：/* PROOJECCT CCODEE：项目目代号或或名称* CREEATEE DAATE ：创建建日期* CREEATEED BBY：创建建人* FUNNCTIION：模块块功能* MODDIFYY DAATE：修改改日期* DOCCUMEENT：参考考文档* OTHHERSS：程序序员认为为应做特特别说明明的部分分，如特特别的编编

34、译开关关*/不同的修修改人应应在修改改的地方方加上适适当的注注释，包包括修改改人的姓姓名。另另外，如如有必要要，要注注明模块块的工作作平台，如如单板OOS、DOSS、WINNDOWWS等。注注明适用用的编译译器和编编译模式式。2。函数描描述函数是组组成模块块的单元元，一般般用来完完成某一一算法或或控制等等。在每每一函数数的开头头应有如如下的描描述体：/* FUNNCTIION NAMME：函函数名称称* CREEATEE DAATE ：创创建日期期* CREEATEED BBY ：创创建人* FUNNCTIION ：函函数功能能* MODDIFYY DAATE ：修改改日期* INPPUT ：

35、输入参参数类型型(逐个说说明)* OUTTPUTT ：输输出参数数类型(逐个说说明) * RETTURNN ：返返回信息息*/可选的描述述有：* RECCEIVVED MESSSAGGES：收到的的消息* SENNT MESSSAGGES ：发送送的消息息* DATTABAASE ACCCESSS ：存取的的数据库库* CALLLEDD BYY ：该该函数的的调用者者* PROOCEDDUREES CCALLLED：调用的的过程* * RECCEVEED PPRIMMITIIVESS : 收到的的原语* SENNT PPRIMMITIIVESS : 发送的的原语*及其它程序序员认为为应有的的描

36、述。标标题可以以只大写写第一个个字母。例例如：FFuncctioon NNamee：3。命名规规则：A) 函函数： 函数名名应能体体现该函函数完成成的功能能，关键键部分应应采用完完整的单单词，辅辅助部分分若太长长可采用用缩写，缩缩写应符符合英文文的规范范。每个个单词的的第一个个字母大大写。如如：ShhowPPoinnts，CtrrlDeestBBoarrd，SenndReesettMsgg 等。B) 变量量： 变量的的命名规规则部分分采用匈匈牙利命命名规则则(鼓励完完全使用用匈牙利利名规则则)。变量量的第一一个或前前两个字字母小写写，表示示其数据据类型，其其后每个个词的第第一个字字母大写写。推

37、荐荐的类型型前缀如如下：前缀含义前缀含义a数组nshortt inntbBOOLnp短指针byBYTEp指针ccharlLONGcb字节记数lp长指针cr颜色参考值值s串cx,cyy短型（x,y长度度的记数数）sz以零结尾的的串dwDWORDDtm文本fn函数wWORDhHANDLLEx,y短型（x或或y的坐标标）iintg_全局变量m_类的数据成成员ucunsiggnedd chhar 如iCurrrenntVaaluee，uTrranssitiionCCounnt 等等。对于于其他复复合类型型或自定定义类型型，请用用适当的的前缀来来表示。除除局部循循环变量量外，不不鼓励单单个字母母的变量量

38、名。对于常用的的类型定定义，尽尽量使用用WORRD、BOOOL、LPWWORDD、VOIID、FARR、NEAAR等惯惯用写法法，避免免使用ccharr、lonng、voiid、farr、neaar等小小写格式式。不使使用_UUC、 _UUL等XXXXXX公司以以前一些些人的习习惯写法法。C) 结结构：结结构的定定义有两两个名称称，一个个是该结结构的类类型名，一一个是变变量名。按按照C语言的的语法，这这两个名名称都是是可选的的，但二二者必有有其一。我我们要求求写类型型名，类类型名以以tagg做前缀缀。下面面是一个个例子：struuct taagVBBXEVVENTT HCTTLhCoontrr

39、ol;HWNNDhWiindoow;inttnIDD;inttnEvventtInddex;LPCCSTRRlpEEvenntNaame;inttnNuumPaaramms;LPVVOIDDlpPParaamLiist;veMMyEvventt;tagVVBXEEVENNTveMMyEvventtMAAXEVVENTTTYPPE, *llpVBBXEvventt; 对对于程序序中常用用的结构构，希望望能使用用 tyypeddef 定义，格格式如下下：typeddef strructt taagMYYSTRRUCTT sttrucct mmembberss . TMMYSTTRUCCT,* PT

40、TMYSSTRUUCT,FARR * LPTTMYSSTRUUCT;strucct 后后的类型型名有ttag前前缀，自自定义的的结构名名称一律律用大写写字母，前前面可以以加一大大写的TT。而结结构类型型变量定定义则可可以写为为：TMYSTTRUCCT varriabblennamee;并可在定义义 MYYSTRRUCTT_S 同时根根据需要要，定义义其指针针，远指指针和尺尺寸常量量：typeddef taggMYSSTRUUCT sttrucct mmembberss TMYSSTRUUCT,* PPTMYYSTRRUCTT,FAAR * LPPTMYYSTRRUCTT;#defiine MY

41、SSTRUUCTSSIZEE sizzeoff ( TMYYSTRRUCTT );结构变量的的命名，建建议采用用如下方方式：从结构名名中，取取出二至至三个词词的首字字母作为为代表此此结构的的缩写，小小写作为为变量前前缀。例例如：（取取自Miicroosofft WWinddowss示例）strructt OPPENFFILEENAMME ofnnMyFFileestrrcutt CHHOOSSECOOLORR cccSccreeenCoolorrD) 联联合：联联合的命命名规则则和结构构相似，如如：unioon ttagMMYEXXAMPPLE inttiInntegger;lonnglLoongIInt;