The LabVIEW Style Book译文共享第九章by 微笑鱼.docVIP

9. Documentation 9. 文档资料 Documentation is any description of the structure, components, or operation of a system, application, or source code. Documentation includes specifications, design documents, source code documentation, user manuals, and online help. Specifications and design documents are discussed in Chapter 2, Prepare for Good Style. Source code documentation consists of comments, descriptions, and text that are useful for the developers to understand the source code. A user manual is a document describing how to operate the software from the end users perspective. Online help is documentation that is electronically integrated with the application. 文件是是结构、元件、系统操作、应用程序或者源代码的 一些描述。文件包括规格、文档设计、源代码文件、用户手册和在线帮助。规格和设计文档在第二章“prepare for Good Style”中已经讨论过。源代码文件包括评论、说明和用于开发者理解源代码的文字。用户手册文档从用户的角度介绍了如何操作软件，在线帮助文档被电子集成到应用程序中。 All of these types of documentation apply to LabVIEW applications. Documentation requirements vary widely depending on the application type, developer, end user, organization, and industry. For example, a commercial application may require an extensive user manual and online help, whereas a one-of-a-kind lab experiment may require no documentation at all. Many organizations have a set of internal standards that all software and systems must adhere to. Government-regulated industries traditionally have stringent documentation requirements imposed by regulatory committees such as the Food and Drug Administration. This chapter focuses on LabVIEW source code documentation that comprises good LabVIEW development style, regardless of the developer, end user, organization, or industry. 所有这些类型的文件应用到LabVIEW应用程序当中。文件需求很大程度上取决于应用程序类型、开发者、最终用户、组织和行业。例如，一个商业应用会需要更多的用户手册和在线帮助，whereas a one-of-a-kind lab experiment may require no documentation.许多组织内部都有一系列的所有软件和系统都必须坚持标准。政府管理部门历来都有严格的要求实行管理委员会，如食品和烟草部门。本章关注的是LabVIEW源代码文档，包括好的LabVIEW开发风格，不管是开发者、终端用户、组织和行业。 Myth 9.1 LabVIEW diagrams are self-documenting.（LabVIEW程序图自我记录） The graphical nature of LabVIEW presents a