再一次强调语义的重要性,在代码说明中也是如此

Posted On Sunday, July 18th, 2010 By admin

比如我们为一个类型做了这样的说明:

    /// <summary>
    /// 检测信息设置
    /// </summary>
    public abstract class CheckCommon

“检测信息设置”,这六个字,存在双重语义,可以理解为 “检测—信息设置”和“检测信息—设置”,前者是动词-名词的组合,后者是名词-动词的组合,这样子的文字表达方式在多人协同开发环境下,在开发framework的情况下、甚至是半年后自己查看自己编写的这段话,都有可能理解错误。进一步的,就会让基于这个SDK之上开发的程序做了本来不该做的事情。

“检测信息设置” 改为“设置检测信息”,这样子就好多了。

Leave a Reply