coldfusion - 在 CF9 中编写 cfc 的编码约定？

Question

随着在 CF9 中编写 CFC 的新方法，CF9 有哪些新的编码约定？

这里有一些我能想到的...

始终使用 LOCAL 范围
始终包含init()返回自身的方法，因为New如果找到会调用 init()。
如果它是 ORM 实体，请不要放入所需的参数，否则会出现异常...init()
始终使用THIS.setXXXinit() 中的 XXX 是属性名称，以便它会调用隐式设置器或自定义设置器（如果可用）。
放弃 CF8 之前的实例范围约定，请参阅：http ://henrylearnstorock.blogspot.com/2009/08/should-we-abandon-instance-scope-in-cf9.html
脚本样式 CFC 中的组件和函数没有 output=false，请参阅： http: //www.coldfusionjedi.com/index.cfm/2009/8/26/Ask-a-Jedi-Impact-of-whitespace-and-script氟氯化碳
使用更清洁、更高效isNull(arguments.optionalArg)的代替isDefined()

score 2 · Accepted Answer

我们还需要为脚本样式 CFC 中的组件和函数设置属性 output=false 吗？

我不会这么认为。<cfscript>从本质上讲，它会抑制任何空白和需要writeOutput()，以便完全有任何输出。

score 0 · Accepted Answer

如果您使用“new my.cfc()”语法调用它，则您的 init() 方法不必返回“this”范围。真实的故事。

如果您在 cfc 中并想设置属性，请不要使用 this.setFoo()，只需使用 setFoo()。getFoo() 也是如此。this.xxx() 就像走出前门只是为了回来。此外，您的 access=private 自定义 getter 和 setter 将无法工作，因为函数不会在 this 范围内。

“var foo” vs “local.foo” - 就个人而言，我更喜欢 var'd 变量，因为 a) 需要输入的代码更少，b) 需要读取的代码更少。

// there isnt a huge difference here
var today = now();
var tomorrow = dateAdd( 'd', 1, today );
local.today = now();
local.tomorrow = dateAdd( 'd', 1, local.today );

// but when you start getting more complex examples, it quickly blows out
var out = method( var1, var2, var3, var4, var5 );
local.out = method( local.var1, local.var2, local.var3, local.var4, local.var5 );

使用 javadocs 风格的注释。文档是你的朋友。

/**
* @hint This is a hint for the whole function
* @arg1 This is an argument hint
* @arg2 This is another argument hint
**/
public void function myFunction( string arg1 = 'default', boolean arg2 ) {
    return true;
}

score -1 · Accepted Answer

所有改变数据的函数都应该返回一些值，即使它是一个当前始终为真的布尔值。函数有一种最终需要返回 false 的方式

coldfusion - 在 CF9 中编写 cfc 的编码约定？

3 回答 3

Related

Reference