coldfusion - CFScript で記述する場合、ヒンティングテクニック間に考慮すべき審美的でない違いはありますか?

Question

私は、CFScript でコードヒントを記述する 2 つの方法を知っています。この 2 つの間に機能的で美的でない違いがあるかどうか、および何がベストプラクティスと見なされるかを知りたいです。

私が見た最初のテクニックは、関数の宣言の上にコメントを使用してヒントを追加します。

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

2 番目の手法では、ヒントを宣言自体に組み込みます。

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

一方を使用し、他方を使用しない理由はありますか? ほのめかしたいかもしれないと宣言する議論がある場合、あなたのアプローチは変わりますか?

score 6 · Accepted Answer

最初のスタイルである JavaDoc スタイルは、少しきれいに見えますが、個人的に大きな不満があります。

コメントによってコードの実行方法が変更されることはありません。これまで。それがコメントと呼ばれる理由です！

そのため、見た目はきれいではありませんが、2 番目のスタイルを好みます。

score 2 · Accepted Answer

注釈スタイル /** */ とインラインの使用の間に、私が認識している機能上の違いはありません。また、単なるヒントではありません。任意の属性を注釈またはインラインに配置できます。私の知る限り、それは純粋に審美的な選択です。

明確にするために：

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

機能的にはまったく同じことを行います

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

score 1 · Accepted Answer

属性の使用getComponentMetaData()は、コメントよりも優先されます。それ以外の場合、技術的な違いはありません。cfscript コンポーネントに関する Adobeのドキュメントは、実際、このトピックに関して非常に優れています。

コメントを使用することは、先行するコードとは一線を画しているため、読者に意図を伝えるためのより良い方法だと思います。一方、属性は、その情報を他のコードとインラインで配置するため、カスタマイズ (ORM のヒントなど) を適用するのに適しています。

coldfusion - CFScript で記述する場合、ヒンティング テクニック間に考慮すべき審美的でない違いはありますか?