1
PLC编程实用指南
1.12.5.6 8.5.6  PLC程序文档
8.5.6 PLC程序文档

通过现场调试的程序,要在计算机中定型,并存储在磁盘或光盘中。此外,还要建立必要的程序文档。

这个程序文档,除了源程序代码,一般还应包括插入到程序代码中的注释和专门制作的文件。这是PLC程序编写、调试成功后必须完成的一个重要工作。程序交付给使用方,也应当交付这个文档。

注释是插入到PLC程序代码行中的解释性注解。有了注释的程序比较容易理解。在什么地方该加注释?并没有固定的法则。大体上讲,一个文档比较好的程序,都包含解释程序目的注释,各程序段的功能注释,特殊指令的使用注释等。在一些意思不太明确的地方也应加上注释。

专门制作的文档不属于程序,是一些编程和程序使用的有关信息。文档既可以是文字的,又可以是电子格式的。一般有两个:程序手册和用户手册。

程序手册包含所有编程的有用信息,包括问题描述和算法。程序手册是软件开发和维护的工具。设计者才用,用户不用。

用户手册包含用户使用程序的所有信息,可以帮助用户学会使用该PLC程序。用户手册的电子版本通常还能给用户提供在线式帮助。

编程人员在编制程序的同时,一般要负责编写程序手册及用户手册。后者也可由专业的科技作家去编写。科技作家专门解释科技概念和程序,把复杂的概念简化,非技术人员阅读时,将更便于理解。