函数设计

来源:互联网 发布:网络教育统考 编辑:程序博客网 时间:2024/06/07 08:21

函数接口的两个要素是参数和返回值。对于C++而言,参数和返回值的传递方式有三种,值传递,指针传递和引用传递。

参数规则
(1)参数的书写要完整,不要贪图省事只写参数的类型而省略参数名字。如果没有参数,则用void填充。
(2)参数命名要恰当,顺序要合理。
(3)如果参数是指针,且仅作输入用,则应在类型前加const,以防止该指针在函数体内被意外修改。
(4)如果输入参数以值传递的方式传递对象,则宜改用“const &”方式来传递,这样可以省略临时对象的构造和析构过程,从而提高效率。
(5)避免函数有太多的参数,参数个数尽量控制在5个以内,如果参数太多,在使用时容易将参数类型或顺序搞错!
(6)尽量不要使用类型和数目不确定的参数。这种风格函数在编译时丧失了严格的类型安全检查。

返回值规则
(1)不要省略返回值的类型。C语言中凡不加类型说明的函数,一律自动按整形处理,这样做不会有什么好处,却容易被误解为void类型。C++语言是一门对类型极其苛刻,会有安全的检查,不允许上述情况发生,由于C++程序可以调用C函数,为了避免混乱,规定任何C++/C函数都必须有类型。如果函数没有返回值,那就应申明为void类型。
(2)函数名字与返回值类型在语义上不可冲突。
(3)不要将正常值和错误标志混在一起返回,正常值用输出参数获得,而错误标志用return语句返回。一般最好的处理方式将错误标志位作为返回,而传值用参数(指针形式)传出。
(4)有时候函数原本不需要返回值,但为了增加灵活性如支持链式表达,可以附加返回值。
(5)如果函数返回值是一个对象,有些场合用引用传递替换值传递可以提高效率,而有些场合只能用值传递而不能用引用传递,否则会出错。值传递需要额外的拷贝开销。

函数内部实现的规则
不同功能的函数其内部实现各不相同,看起来似乎无法就“内部实现”达成一致的观点,但根据经验,我们可以在函数体的入口处和出口处从严把关,从而提高函数的质量。
(1)在函数体的入口处,对参数的有效性进行检查。很多程序错误都是由非法参数引起的,我们应该充分理解并正确使用“断言”assert来防止此类错误。
(2)在函数的出口处,对return语句的正确性和效率进行检查。对于有返回值的函数,return写得好与坏会影响函数的运行或效率。
<1>return语句不可返回指向“栈内存”的指针或者引用,因为该内存在函数体结束时被自动销毁。
<2>要搞清楚返回的是值还是指针,还是引用。
<3>函数返回值是一个对象要考虑return语句的效率,最好采用引用返回,因为效率问题!!对象需要构造和析构,都需要时间!
(3)函数的功能要单一,不要设计多用途的函数。
(4)函数体的规模要小尽量控制在50行代码之内。
(5)尽量避免函数带有记忆功能,相同的输入产生相同的输出。在C/C++语言中,函数static的局部变量是函数的记忆存储器,建议尽量少用static局部变量,除非必须!
(6)不仅要检查输入参数的有效性,还要检查通过其它用途进入函数体内的变量的有效性,如全局变量、文件句柄等
(7)用于出错处理的返回值一定要清楚,让使用者不容易忽视或误解错误情况。

使用断言
程序一般分为debug和release版本,debug版本用于内部调试,release版本发行给用户使用。断言assert是仅在debug版本起作用的宏,它用于检查不应该发生的情况。

assert不是一个仓促拼凑起来的宏,为了不在程序的debug和release版本引起差别,assert不应该产生任何副作用。所以assert不是函数,而是宏。程序员可以把assert看成一个在任何系统状态下都可以安全使用的无害测试手段,如果程序在assert处终止了,并不是说含有该assert的函数有错误,而是调用者出了差错,assert可以帮助我们找到发生错误的原因。
(1)使用断言捕捉不应该发生的非法情况,不要混淆非法情况与错误情况之间的区别,后者是必然存在的并且是一定要作出处理的。
(2)函数入口处,使用断言检查参数的有效性(合法性)。
(3)编写函数时,要进行反复的考查,并且自问:我打算做哪些假定?一旦确定了的假定,就要使用断言对假定进行检查。
(4)当进行犯错设计时,如果不可能发生的事情的确发生了,则要使用断言进行报警!