使用过Plant的朋友应该都有体会，实际的仿真项目离不开大量的程序。高超的编程能力可以把Plant的功能发挥的淋漓尽致，优秀的编程注释习惯就是这种能力的一种体现。

大家一定有这种体验，自己写的项目模型，过一段时间需要维护或者升级功能的时候，打开来一头雾水，要花很长时间才能进入状态。如果是团队合作，或者修改他人的模型，往往有一种想杀人的冲动。造成这种现象的原因：一方面是模型庞大，逻辑关系复杂；另一方面则是Method中程序的注释写的不好，程序的可读性太差。

个人认为程序的注释可以分为两大类：

一、系统总体逻辑流程，这种一般体现在建模之前的准备文档中，没有固定的模板，大多数情况下以流程图、框图的形式呈现。

二、模型每一个Method中的程序注释，可以分为主程序注释和主程序头部注释。主程序的注释主要注释出关键行的意义，关键循环的含义等，没有统一的格式。程序头部注释则是标注出该程序的作用、调用关系、作者、修改时间等信息，可以采用固定的模板，我将分享给大家的就是程序头部注释模板。

 团队开发模板：这种程序头部注释模板适用于团队、公司开发环境，信息比较全面。如下：

/*_______________________www.taoyifei.tech_____________________________

Method Tasks : 描述method的主要作用
_______________________________________________________________________

Parameters : 描述method定义的所有局部变量和作用
 
ReturnValues : 描述程序的返回值及作用

Called By : 描述被调用关系

Calls : 描述调用关系

Author : 作者、联系方式

Date : 建模时间
_______________________________________________________________________

History : Method每次被修改或升级的记录（时间、作者、联系方式、改动内容）
_______________________________________________________________________*/

个人开发模板：与团队开发模板比较，最大的不同就是更加简洁。如下：

/*_______________________www.taoyifei.tech_____________________________

Method Tasks : 描述method的主要作用
_______________________________________________________________________

Parameters : 描述method定义的所有局部变量和作用
 
ReturnValues : 描述程序的返回值及作用

Called By : 描述被调用关系

Calls : 描述调用关系
_______________________________________________________________________*/

这两种模板是我借鉴了国外专家，并结合自己多年经验总结出来，且确实比较好用，希望能够帮到大家，更加高效快捷的coding & debugging！

提示：单行注释符号 – -，多行注释用 /*…….*/ 括住注释内容，同时可将模板预置到Method父本中，方便使用。