在使用CFScript编写时,提示技术之间是否存在非审美差异？

Question

我知道在CFScript中编写代码提示的两种方法.我想知道两者之间是否存在任何功能性,非美学差异,以及什么是最佳实践.

我见过的第一种技术使用函数声明上方的注释来添加提示:

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

虽然第二种技术将提示纳入声明本身:

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

是否有理由使用一个而不是另一个？如果您有参数声明您可能想提示,您的方法是否会改变？

Answer 1

第一种风格,JavaDoc风格,看起来有点清洁,但我对它有一个巨大的个人抱怨:

注释永远不会改变代码的运行方式.EVER.这就是他们被称为评论的原因!

这就是为什么我更喜欢第二种风格,即使它看起来不那么干净.