处理可选参数:CFArgument 与 isDefined
Handling optional arguments: CFArgument versus isDefined
我有一个关于 cfargument
的问题。如果我在调用 .cfc
时发送参数,首先将其定义为参数有什么好处吗?
<cffunction name="someFunction" ....>
<cfargument name="myArg" required="no">
或者我可以只在函数内部使用 IsDefined() 而不定义参数吗?
<cffunction name="someFunction" ....>
...
<cfif isDefined("arguments.myArg")>
do something
</cfif>
我试过了,知道它们都有效。但是,定义参数和使用 isDefined() 有什么区别?这会影响效率吗?
这与效率无关,与文档有关。这是我公司关于 cfargument
.
的编码标准文档的摘录
在 ColdFusion 函数中使用 CFARGUMENT 标签时,需要以下属性:
- 姓名
- 类型
- 必填
- 提示
ColdFusion 不要求您使用 cfargument
标签,但它们提供验证(类型安全)并充当附加文档,因此始终为您的函数期望的每个命名参数提供一个 cfargument
标签。
规则:
- 参数的名称不必以数据类型为前缀(避免匈牙利表示法)。
- 始终在您的 cfargument 标签中指定
type
属性。尽量避免使用 type="any"
.
- 如果需要参数,请指定
required="true"
但不要指定 default
属性值。
- 如果不需要参数,请指定
required="false"
并指定 default
属性值。
- 如果你需要检测是否提供了一个非必需的参数,不要指定
default
,而是在函数体中使用structKeyExists(arguments,"ARGNAME")
(记住当你指定default
],您无法区分省略该参数的调用者与提供相同默认值作为参数的调用者之间的区别。
- 当引用作为参数传递给函数的变量时,始终引用参数范围。 (不要引用
foo
,请引用 arguments.foo
。)
- 不要操纵传递给函数的参数值。 CF 通过引用 传递一些变量数据类型 并且在函数内完成的任何操作都会改变调用它的级别的变量值。使用 duplicate() 将参数结构复制到函数局部变量以避免冲突,然后根据需要操作函数局部变量。
- 不要将键添加到最初未传递到函数中的参数结构。添加新密钥会使调试变得非常困难。相反,使用复制将参数结构复制到新的函数局部变量以避免冲突并向该结构添加新键。
HTH
我有一个关于 cfargument
的问题。如果我在调用 .cfc
时发送参数,首先将其定义为参数有什么好处吗?
<cffunction name="someFunction" ....>
<cfargument name="myArg" required="no">
或者我可以只在函数内部使用 IsDefined() 而不定义参数吗?
<cffunction name="someFunction" ....>
...
<cfif isDefined("arguments.myArg")>
do something
</cfif>
我试过了,知道它们都有效。但是,定义参数和使用 isDefined() 有什么区别?这会影响效率吗?
这与效率无关,与文档有关。这是我公司关于 cfargument
.
在 ColdFusion 函数中使用 CFARGUMENT 标签时,需要以下属性:
- 姓名
- 类型
- 必填
- 提示
ColdFusion 不要求您使用 cfargument
标签,但它们提供验证(类型安全)并充当附加文档,因此始终为您的函数期望的每个命名参数提供一个 cfargument
标签。
规则:
- 参数的名称不必以数据类型为前缀(避免匈牙利表示法)。
- 始终在您的 cfargument 标签中指定
type
属性。尽量避免使用type="any"
. - 如果需要参数,请指定
required="true"
但不要指定default
属性值。 - 如果不需要参数,请指定
required="false"
并指定default
属性值。 - 如果你需要检测是否提供了一个非必需的参数,不要指定
default
,而是在函数体中使用structKeyExists(arguments,"ARGNAME")
(记住当你指定default
],您无法区分省略该参数的调用者与提供相同默认值作为参数的调用者之间的区别。 - 当引用作为参数传递给函数的变量时,始终引用参数范围。 (不要引用
foo
,请引用arguments.foo
。) - 不要操纵传递给函数的参数值。 CF 通过引用 传递一些变量数据类型 并且在函数内完成的任何操作都会改变调用它的级别的变量值。使用 duplicate() 将参数结构复制到函数局部变量以避免冲突,然后根据需要操作函数局部变量。
- 不要将键添加到最初未传递到函数中的参数结构。添加新密钥会使调试变得非常困难。相反,使用复制将参数结构复制到新的函数局部变量以避免冲突并向该结构添加新键。
HTH