您的位置:控制工程论坛网论坛 » 嵌入式系统 » 如何编写高质量的子程序

zhiy66

zhiy66   |   当前状态:在线

总积分:6528  2024年可用积分:0

注册时间: 2007-12-18

最后登录时间: 2012-01-11

空间 发短消息加为好友

如何编写高质量的子程序

zhiy66  发表于 2008/10/12 23:14:20      689 查看 1 回复  [上一主题]  [下一主题]

手机阅读

子程序

它是为实现一个特定的目的而编写的一个可被调用的方法(method)或过程(procedure)。

 

高质量的子程序

要点

1.       创建子程序的主要目的是提高程序的可管理性,当然也有其他一些好的理由。其中,节省代码空间只是一个次要原因;提供可读性、可靠性和可修改性等原因更重要一些;

2.       有时候,把一些简单的操作写成独立的子程序也非常有价值;

3.       子程序可以按照其内聚性分为很多类,而你应该让大多数子程序具有功能上的内聚性,这是最佳的一种内聚性;

4.       子程序的名字是其质量的指示器。如果名字糟糕但恰如其分,那就说明这个程序设计得很差劲。如果名字糟糕而且又不准确,那么它就反映不出程序是干什么的。不管怎样,糟糕的名字都意味着程序需要修改;

5.       只有在某个子程序的主要目的是返回由其名字所描述的特定结果时,才应该使用函数;

6.       细心的程序员会非常谨慎地使用宏,而且只是在万不得已时采用。

 

如何判定高质量的子程序

大局上的

1.       创建子程序的理由充分码?

2.       一个子程序中所有适合单独提出作为子程序的部分是否已经全部提取出?

3.       过程的名字是否用了强烈、清晰的“动词+宾语”词组?函数的名字是否描述了其返回值?

4.       子程序的名字是否描述了它所做的全部事情?

5.       是否给常用的操作建立了命名规则?

6.       子程序是否具有强烈的功能上的内聚性?即它是否做且只做了一件事,并且把它做得很好?

7.       子程序之间是否有较松的耦合?子程序与其他子程序之间的连接是否是小的(small)、明确(intimate)、可见的(available)和灵活(flexible?

8.       子程序的长度是否由其功能和逻辑自然确定,而非遵循任何人为的编码标准?

 

参数传递事宜:

1.       整体来看,子程序的参数表是否出现一种具有整体性且一致的接口抽象?

2.       子程序参数的排列顺序是否合理?是否与类似的子程序的参数排列顺序相符?

3.       接口假定是否已在文档中说明?

4.       子程序的参数格式是否没超过7个?

5.       是否用到了每一个输入参数?

6.       是否用到了每一个输出参数?

7.       子程序是否避免了把输入参数作为工作变量?

8.       如果子程序是一个函数,那么它是否在所有可能的情况下都能返回一个合法的值?

 

创建子程序的正当理由:

1.       避免代码重复;

2.       支持子类化;

3.       隐藏顺序;

4.       隐藏指针操作;

5.       提高可移植性;

6.       简化复杂的布尔判断;

7.       改善性能。

除此以外,创建类的很多理由也是创建子程序的理由:

1.       隔离复杂度;

2.       隐藏实现细节;

3.       限制变化所带来的影响;

4.       隐藏全局数据;

5.       形成中央控制点;

6.       促成可重用的代码;

7.       达到特定的重构目的。

注意:编写一个有效的子程序时,一个最大的心理障碍是不情愿为一个简单的目的而编写一个简单子程序。写一个只有两三行代码的子程序可能看起来有些大材小用,但经验可以表明,一个很好的又小巧的子程序会多有用。

1楼 0 0 回复
  • sdp_1984

    sdp_1984   |   当前状态:离线

    总积分:272  2024年可用积分:0

    注册时间: 2007-12-13

    最后登录时间: 2009-02-02

    空间 发短消息加为好友

    sdp_1984   发表于 2008/10/12 23:14:20

    很好,一直在这么写
    2楼 回复本楼

    引用 sdp_1984 2008/10/12 23:14:20 发表于2楼的内容

总共 , 当前 /