使用MASM－代码风格(2)

2. 注释和空行 没有注释的程序是很难维护的，但注释的方法也很有讲究，写注释要遵循以下的规则： ●   不要写无意义的注释，如“将1放到eax中”，“跳转到exit标号处”等。 ●   修改代码同时修改相应的注释，以保证注释与代码的一致性。 ●   注释以描写一组指令实现的功能为主，不要解释单个指令的用法，那是应该由指令手册来完成的，不要假设看程序的人连指令都不熟悉。 ●   对于子程序，要在头部加注释说明参数和返回值，子程序可以实现的功能，以及调用时应该注意的事项。 由于汇编语言是以一条指令为一行的，实现一个小功能就需要好几行，没有分段的程序很难看出功能模块来，所以要合理利用空行来隔开不同的功能块，一般以在高级语言中可以用一句语句来完成的一段汇编指令为单位插入一个空行。 3. 避免使用宏 在MASM的宏功能中最好只使用条件汇编，用来选择编译不同的代码块来构建不同的版本，其他如宏定义和宏调用只会破坏程序的可读性，能够不用就尽量不用，虽然展开后只有一两句的宏定义不在此列，但既然展开后也只有一两句，那么和直接使用指令也就没有什么区别了。 在汇编中避免使用宏定义的理由是：汇编中随时要用到各个寄存器，宏定义不同于子程序，可以有选择地保护现场，在使用中很容易忽略里面用了哪个寄存器，从而对程序结构构成威胁。高级语言的宏定义则不会有这个问题。 笔者曾经见到过最极端的使用宏定义的程序是MicroMedia的Director SDK，100行左右的例子中几乎有90%都是宏定义，虽然例子很容易改成其他功能的程序，但要在里面加入新的功能则几乎是不可能的，因为程序中连C语言函数开始和结束的花括号都被改成了宏定义，这样一来，如果要真正使用这个开发包，则必须把宏定义“翻译”回原来的样子才能真正理解程序的流程。对于这样的代码，笔者是绝对不敢苟同的。 3.6.3  代码的组织 程序中要注意变量的组织和模块的组织方式。 过多的全局变量会影响程序的模块化结构，所以不要设置没必要的全局变量，尽量把变量定义成局部变量。把仅在子程序中使用的变量设置为局部变量可以使子程序更容易封装成一个黑匣子，如果无法把全部变量设置为局部变量，则尽量把这些数据改为参数输入输出，如果无法改为参数，那么意味着这个子程序不能不经修改地直接放到别的程序中使用。 在主程序中使用比较频繁的部分，以及便于封装成黑匣子在别的程序上用的代码，都应该写成子程序，但一个子程序的规模不应该太大，行数尽量限制在几百行之内，功能则限于完成单个功能。对于子程序，定义参数的时候要尽可能精简，对可能引起程序崩溃的参数，如指针等，要进行合法性检测。 子程序中在使用完申请的资源的时候，注意在退出前要释放所用资源，包括申请的内存和其他句柄等，对于打开的文件则要关闭。 对于程序员来说，开发每一个软件都要从头做起是很浪费时间的，一般的做法是从自己以前做过的程序中拷贝相似的代码，但修改还是要花一定的时间，最好的办法就是尽量把子程序做成一个黑匣子，可以不经修改地直接拿过来用，这样，每次编程相当于只是编写新增的部分，随着代码的积累，开发任何程序都将是很快的事情。

来源：电子工业出版社 作者：罗云彬