coldfusion - 使用 CFScript 编写时，提示技术之间是否存在非美学差异需要考虑？

Question

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

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

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

第二种技术将提示合并到声明本身中:

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

是否有理由使用一种而不是另一种？如果你有论据声明你可能想要暗示，你的方法会改变吗？

Answer 1

第一种风格，JavaDoc 风格，看起来更简洁一些，但我个人对它有很大的提示:

注释永远不应该改变代码运行的方式。曾经。这就是为什么它们被称为评论!

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