很多时候,从一个工程师的程序注释就能看出其编程水平高低,一个高水平的程序备份,简洁实用的程序注释必不可少,千万别一段时间后自己也看不懂自己写的程序,那将是一件很悲催的事情。今天我们就来谈谈五类让人不胜其扰的注释,还有五类生成它们的工控技术人员。
傲娇型
这类组态人员对其组态能力自视甚高,以至于他觉得有必要在每行代码后都要签上自己的大名。让所有维护以及看过梯形图的人都知道他的存在。怎么感觉是在说我呢!
过时型
如果一行梯形图不再使用了(也就是过时了),请删除它——勿要使用跳转或者永不闭合常开来闲职它,这样让你的工作梯形图被数行冗余的注释弄得七零八乱。
显然型
我们都知道PLC组态的基本工作逻辑——这可不是什么“编程入门”!你无需浪费时间解释显而易见的组态逻辑的工作原理,虽然我们很高兴看到你愿意解释代码的功能——但这不过是画蛇添足。
传记型
如果你非得在梯形图中提到某些必需的东西,也别提到人名。如:“作者:俺村俺最牛”,也许这个人离开这家公司了,那些阅读代码的PLC人员极可能根本就不知道他是谁,更甭提注释里那些毫无干系的事情。
拖延型
如果有什么需要修补的,趁现在动手,而不要推迟了很长时间在某一个角落写上曾经的回忆式的注释,这样让别人看的摸不着头脑
文章来源于:电子工程世界 原文链接
本站所有转载文章系出于传递更多信息之目的,且明确注明来源,不希望被转载的媒体或个人可与我们联系,我们将立即进行删除处理。