硬件开发流程及规范

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

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

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

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

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

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

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

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

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

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

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

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

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

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

15、。只有对对各种可可能的环环节验证证到才能能保证机机器走向向市场后后工作的的可靠性性和稳定定性。联联调后，必须经经总体办办和管理理办，对对联调结结果进行行评审，看是不不是符合合设计要要求。如如果不符符合设计计要求将将要返回回去进行行优化设设计。如果联调调通过，项目要要进行文文件归档档，把应应该归档档的文件件准备好好，经总总体办、管理办办评审，如果通通过，才才可进行行验收。总之，硬硬件开发发流程是是硬件工工程师规规范日常常开发工工作的重重要依据据，全体体硬件工工程师必必须认真真学习。第二节硬硬件开发发文档规规范2.22.1 硬件开开发文档档规范文文件介绍绍为规范硬硬件开发发过程中中文档的的编写，明

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

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

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

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

20、时时候单板板硬件详详细设计计便为软软件设计计者提供供了一个个详细的的指导，因此单单板硬件件详细设设计报告告至关重重要。尤尤其是地地址分配配、控制制方式、接口方方式、中中断方式式是编制制单板软软件的基基础，一一定要详详细写出出。5、单板板软件详详细设计计在单板软软件设计计完成后后应相应应完成单单板软件件详细设设计报告告，在报报告中应应列出完完成单板板软件的的编程语语言，编编译器的的调试环环境，硬硬件描述述与功能能要求及及数据结结构等。要特别别强调的的是：要要详细列列出详细细的设计计细节，其中包包括中断断、主程程序、子子程序的的功能、入口参参数、出出口参数数、局部部变量、函数调调用和流流程图。在有

21、关关通讯协协议的描描述中，应说明明物理层层，链路路层通讯讯协议和和高层通通讯协议议由哪些些文档定定义。6、单板板硬件过过程调试试文档开发过程程中，每每次所投投PCBB 板，工程师师应提交交一份过过程文档档，以便便管理阶阶层了解解进度，进行考考评，另另外也给给其他相相关工程程师留下下一份有有参考价价值的技技术文档档。每次次所投PPCB 板时应应制作此此文档。这份文文档应包包括以下下内容：单板硬硬件功能能模块划划分，单单板硬件件各模块块调试进进度，调调试中出出现的问问题及解解决方法法，原始始数据记记录、系系统方案案修改说说明、单单板方案案修改说说明、器器件改换换说明、原理图图、PCCB 图图修改说

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

23、模块块划分、系统功功能模块块调试进进展、系系统接口口信号的的测试原原始记录录及分析析、系统统联调中中出现问问题及解解决、调调试技巧巧集锦、整机性性能评估估等。9、单板板硬件测测试文档档在单板调调试完之之后，申申请内部部验收之之前，应应先进行行自测以以确保每每个功能能都能实实现，每每项指标标都能满满足。自自测完毕毕应出单单板硬件件测试文文档，单单板硬件件测试文文档包括括以下内内容：单单板功能能模块划划分、各各功能模模块设计计输入输输出信号号及性能能参数、各功能能模块测测试点确确定、各各测试参参考点实实测原始始记录及及分析、板内高高速信号号线测试试原始记记录及分分析、系系统I/O 口口信号线线测试

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

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

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

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

28、品品的工艺艺、结构构、兼容容性及可可生产性性等问题题进行评评审，在在产品开开发的后后期，项项目组将将中试的的相关资资料备齐齐，提交交新产产品准备备中试联联络单，由业业务部、总体办办、中研研计划处处审核后后，提交交中试部部进行中中试准备备，在项项目内部部验收后后转中试试，在中中试过程程中出现现的中试试问题，由中试试部书面面通知反反馈给项项目组，进行设设计调整整直至中中试通过过。由上可见见中试将将在产品品设计到到验收后后整个过过程都将将参与，在硬件件开发上上，也有有许多方方面要提提早与中中试进行行联系。甚至中中试部直直接参与与有关的的硬件开开发和测测试工程。3.33.6 内部验验收流程程制定的目目

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

30、：阶段流程图表单硬件需求评估硬件需求分析（包括技术风险评估）硬件开发计划和配置管理计划进度计划表硬件测试计划硬件需求求分析报报告硬件开发发计划硬件测试试计划硬件详细设计详细硬件设计LCD认证流程关键器件采购PCB毛坯图设计内部设计评审硬件详细细设计说说明书硬件电路路原理图图硬件BOOM硬件设计计内部评评审记录录硬件实现测试PCB布板流程软件投板前审查打样、试产硬件调试PCB贴片硬件内部评审整机测试评审后发布并归档硬件修改PCB数数据器件规格格书硬件子系系统软件件装配图硬件单元元测试分分析报告告电装总结结报告硬件系统统测试版版本硬件系统统测试分分析报告告硬件评审审验证报报告发布版本本参考文件件：

31、PCB布布板流程程图LCD认认证流程程图附录二. 软件件设计流流程图：阶段流程图表单软件需求分析软件需求分析（包括技术风险评估）软件开发计划和配置管理计划进度计划表软件测试计划软件需求求规格书书软件开发发计划软件开发发风险控控制计划划软件测试试计划软件详细设计详细软件设计内部设计评审软件详细细设计说说明书软件接口口设计说说明书软件设计计内部评评审记录录软件实现测试编码调试编写测试用例单元测试软件集成/调试评审后发布并归档软件修订软件系统测试发布系统测试版本单元源代代码单元调试试报告单元测试试用例单元测试试分析报报告集成后的的软件及及源代码码软件集成成调试报报告软件操作作手册系统测试试软件系统测

32、试试用软件件文档软件系统统测试分分析报告告发布版本本参考文件件：附录三编编程规范范单板软件件编程规规范目的：为为了开发发人员之之间更好好地进行行交流，提高代代码的可可读性，可维护护性，特特制订本本规范，作为程程序编写写的指导导文件。本规范范只涉及及到源码码书写的的格式，希望能能有较统统一的编编程风格格。将来来若有和和公司相相关规定定冲突的的地方，本规范范有可能能作适当当修改。1。模块块描述模块是为为了实现现某一功功能的函函数的集集合，文文件名使使用缺省省的后缀缀，在每每一模块块的开头头应有如如下的描描述体：/* PRROJEECT CODDE：项目目代号或或名称* CRREATTE DDATE

33、E ：创建建日期* CRREATTED BY：创建建人* FUUNCTTIONN：模块块功能* MOODIFFY DDATEE：修改改日期* DOOCUMMENTT：参考考文档* OTTHERRS：程序序员认为为应做特特别说明明的部分分，如特特别的编编译开关关*/不同的修修改人应应在修改改的地方方加上适适当的注注释，包包括修改改人的姓姓名。另另外，如如有必要要，要注注明模块块的工作作平台，如单板板OS、DOSS、WINNDOWWS等。注明适适用的编编译器和和编译模模式。2。函数数描述函数是组组成模块块的单元元，一般般用来完完成某一一算法或或控制等等。在每每一函数数的开头头应有如如下的描描述体：

34、/* FUUNCTTIONN NAAME：函数名名称* CRREATTE DDATEE ：创建日日期* CRREATTED BY ：创建人人* FUUNCTTIONN ：函数功功能* MOODIFFY DDATEE ：修修改日期期* INNPUTT ：输入入参数类类型(逐个说说明)* OUUTPUUT ：输出参参数类型型(逐个说说明) * REETURRN ：返回信信息*/可选的描描述有：* REECEIIVEDD MEESSAAGESS：收到到的消息息* SEENT MEESSAAGESS ：发发送的消消息* DAATABBASEE ACCCESSS ：存取取的数据据库* CAALLEED

35、BBY ：该函数数的调用用者* PRROCEEDURRES CALLLEDD：调用用的过程程* * REECEVVED PRIIMITTIVEES : 收到到的原语语* SEENT PRIIMITTIVEES : 发送送的原语语*及其它程程序员认认为应有有的描述述。标题题可以只只大写第第一个字字母。例例如：FFuncctioon NNamee：3。命名名规则：A) 函数：函数名名应能体体现该函函数完成成的功能能，关键键部分应应采用完完整的单单词，辅辅助部分分若太长长可采用用缩写，缩写应应符合英英文的规规范。每每个单词词的第一一个字母母大写。如：SShowwPoiintss，CtrrlDeest

36、BBoarrd，SenndReesettMsgg 等。B) 变变量：变变量的命命名规则则部分采采用匈牙牙利命名名规则(鼓励完完全使用用匈牙利利名规则则)。变量量的第一一个或前前两个字字母小写写，表示示其数据据类型，其后每每个词的的第一个个字母大大写。推推荐的类类型前缀缀如下：前缀含义前缀含义a数组nshorrt iintbBOOLLnp短指针byBYTEEp指针ccharrlLONGGcb字节记数数lp长指针cr颜色参考考值s串cx,ccy短型（xx,y长长度的记记数）sz以零结尾尾的串dwDWORRDtm文本fn函数wWORDDhHANDDLEx,y短型（xx或y的坐标标）iintg_全局变

37、量量m_类的数据据成员ucunsiigneed ccharr如iCuurreentVValuue，uTrranssitiionCCounnt 等等。对于于其他复复合类型型或自定定义类型型，请用用适当的的前缀来来表示。除局部部循环变变量外，不鼓励励单个字字母的变变量名。对于常用用的类型型定义，尽量使使用WOORD、BOOOL、LPWWORDD、VOIID、FARR、NEAAR等惯惯用写法法，避免免使用ccharr、lonng、voiid、farr、neaar等小小写格式式。不使使用_UUC、 _UUL等XXXXXX公司以以前一些些人的习习惯写法法。C) 结构：结构的的定义有有两个名名称，一一个是

38、该该结构的的类型名名，一个个是变量量名。按按照C语言的的语法，这两个个名称都都是可选选的，但但二者必必有其一一。我们们要求写写类型名名，类型型名以ttag做做前缀。下面是是一个例例子：strructt ttagVVBXEEVENNT HCCTLhCoontrrol;HWWNDhWiindoow;inntnIDD;inntnEvventtInddex;LPPCSTTRlpEEvenntNaame;inntnNuumPaaramms;LPPVOIIDlpPParaamLiist;veeMyEEvennt;taggVBXXEVEENTveMMyEvventtMAAXEVVENTTTYPPE, *ll

39、pVBBXEvventt;对于程序序中常用用的结构构，希望望能使用用 tyypeddef 定义，格式如如下：typeedeff sttrucct ttagMMYSTTRUCCT sstruuct memmberrs . TTMYSSTRUUCT,* PPTMYYSTRRUCTT,FAAR * LPPTMYYSTRRUCTT;struuct 后的类类型名有有tagg前缀，自定义义的结构构名称一一律用大大写字母母，前面面可以加加一大写写的T。而结结构类型型变量定定义则可可以写为为：TMYSSTRUUCT vaariaableenamme;并可在定定义 MMYSTTRUCCT_SS 同时时根据需需要

40、，定定义其指指针，远远指针和和尺寸常常量：typeedeff taagMYYSTRRUCTT sstruuct memmberrs TMYYSTRRUCTT,* PTMMYSTTRUCCT,FFAR * LLPTMMYSTTRUCCT;#deffinee MYYSTRRUCTTSIZZE siizeoof ( TMMYSTTRUCCT );结构变量量的命名名，建议议采用如如下方式式：从结构名名中，取取出二至至三个词词的首字字母作为为代表此此结构的的缩写，小写作作为变量量前缀。例如：（取自自Miccrossoftt Wiindoows示示例）sttrucct OOPENNFILLENAAME offnMyyFillesttrcuut CCHOOOSECCOLOOR ccSScreeenCColoorD) 联合：联合的的命名规规则和结结构相似似，如：unioon ttagMMYEXXAMPPLE inntiInntegger;loonglLoongIInt; myEExammplee;typeedeff ttag