2011-01-06 25 views
4

我知道在CFScript中編寫代碼提示的兩種方法。我想知道兩者之間是否存在任何功能性和非審美性差異,以及什麼是最佳做法。在使用CFScript編寫提示技術時,是否存在非美學差異?

我見過的第一個技術使用函數的聲明上述評論添加提示:

/** 
* @hint This function does soemthing 
*/ 
public function foo() {} 

而第二個技術結合了提示進入聲明本身:

public function foo() hint="This function does something" {} 

是否有原因使用一個而不是另一個?如果你有理由聲明你可能想提示,你的方法是否會改變?

回答

2

我知道在使用註釋樣式/ ** * /和inline之間沒有功能差異。此外,它不僅僅是提示 - 任何屬性都可以放在註釋或內聯中。據我所知,這純粹是一種美學選擇。

澄清:

/** 
*@output false 
*@returnType query 
*/ 
public function foo() {} 

將在功能上做的

public function foo() output='false' returntype='query' {} 
+0

託德,這很有趣......我認爲「public」是聲明「access ='public'的函數的第一個單詞」 - 在註釋中包含它的用途是什麼? – Mohamad 2011-01-06 15:35:41

+0

啊是的 - 抱歉 - 這沒有必要。在我的IDE中查看基於標籤的CFC作爲示例,並沒有引起太多關注。爲了清楚起見,我將它從註釋中移除。 – 2011-01-06 15:41:13

6

同樣的事情的第一個樣式,JavaDoc樣式的,是乾淨了一點看,但我對一個巨大的個人抱怨它:

評論應該永遠不會改變代碼運行的方式。 EVER。這就是爲什麼他們被稱爲評論!

這就是爲什麼我更喜歡第二種風格,即使它看起來不夠乾淨。

1

使用getComponentMetaData()屬性優先於註釋。否則,沒有技術上的差異。 Adobe documentation on cfscript components在這個話題上確實很不錯。

我認爲使用註釋是一種更好的方法來向讀者傳遞意圖,因爲它與前面的代碼截然不同。而屬性更適用於應用自定義(例如,爲ORM提示),因爲它將該信息與其他代碼內聯。

相關問題