规范化编程
规范化编程
编程的规范化与标准化在我们工程师的日常工作中占据了非常重要的地位,养成良好的习惯,树立规范化和标准化的编程习惯对于提升工作效率,降低工作强度,降低日后维护难度,甚至对提高自己的职业素养都是不可或缺的,对于编程中的规范化,我认为主要分为以下三个方面。
1、命名的规范化
命名的规范化的主要优点是使我们的程序的可读性增强,让我们的程序一目了然,同时方便记忆,提高工程师的编程效率,下面我们来详细说明如何规范的进行命名。
上图是程序中对输出点Q0.1在符号表中的命名,该命名主要分为三个部分每个部分用"_"分隔开具体如下图所示。
上图就是命名的基本格式与步骤,在程序中的命名都应该遵循这样的命名原则。
2、程序的规范化编写
不规范的程序编写通常情况下也可以达到编程者所想实现的工序,但在某些特殊的条件下会造成意想不到的结果发生,下面我们举例说明
自锁程序规范化说明
(1)不规范程序示例
(2)规范程序编写示例
3、程序注释的规范化
规范的编写程序注释是一个合格工程师必备的素质,养成良好的对程序注释的习惯,不仅能可以提高程序的可读性,也方便了我们对程序的调试。下面我们来详细说明程序应该如何注释。
程序的注释主要分为两个部分,对程序块的注释,和程序块中各个网络的注释,其中以对程序块的注释要求比较复杂,程序块的注释分为title和comment,title既是该程序块的名称,给程序起名的时候应该尽量表达出该程序块的功能,comment既是该程序块的摘要,程序的摘要主要应反应出以下几点内容。
1、程序的概述,主要是该程序能完成的功能。
2、程序的作者。
3、程序的编写时间。
4、程序的测试情况。
5、程序的版本,(格式为Vesion X.X,小改动版本加0.1,大改
动,版本加1,每次改动还要注明改动的内容)
上图为程序块注释的标准格式。