php注释中附加星号的目的是什么？

我（终于）阅读了PEAR（php）编码标准

这样评论的目的是什么：

/** 
*   Here is my comment
*   I Wrote this in a haiku
*   But why put the stars?
*/

与此相反：

/* 
   Here is a comment
   No haiku or 
   anything special, but it still works!
*/

可读性

---

它向阅读代码的人清晰地突出了注释部分。

我认为它主要是为了外观/可读性。假设您有一个很长的注释部分，它超出了一个屏幕。然后看到这些星号，你就知道这是评论的一部分，即使你看不到开头和结尾。

我同意ajon和Quentin的观点。主要是可读性。然而，还有一件事

有自动文档生成器（如doxygen）

---

它们需要一些特定的注释格式来将这些注释包含到文档中。我相信这种评论风格正是为了这个目的而使用的（请看下面的doxygen文档页面-

某些文档系统有时会使用双星号评论。文档系统将处理该块并查找某些关键字，如@author或@var

单个星号注释将被视为//注释

见PhpDoc

---

文件

/**stuff*/

也称为符号

它用于记录PHP函数、类等

/** 
* A test function
*
* @param  foo $bar
* @return baz
*/
function test(foo $bar) { return new baz; }

一些编辑器很好地利用这一点来执行他们的CodeInsight功能，这是一个非常强大的工具，可以减少您查看旧函数声明的时间。Aptana和Zend Studio有这个功能，可能还有其他功能

---

您还可以将它与结合使用来执行某种AOP，对声明上方的DocBlock进行运行时检查。事实上，条令使用它来为“活动记录”实现构建一个新的框架。

如果您使用优秀的自由文本编辑器jEdit来编辑PHP，它会以不同的颜色突出显示代码，以显示什么是动词，什么是变量等

如果用/*…*/注释掉块块内的所有内容都变为橙色，使代码难以读取

如果您改为使用/**…*/然后，它将块中的所有内容更改为一组不同的颜色，这些颜色仍然突出显示代码的不同部分，这意味着代码仍然非常可读

---

如果你使用记事本或类似的工具来编辑你的PHP代码，我强烈建议你使用jEdit。这将为你节省大量的时间和挫折。像自动指示{}，（）的开始和结束之类的东西。

我就是这么想的……所以这是为了可读性？没有其他好处？如果您使用的编辑器不进行上下文突出显示，它有助于澄清/识别较长的注释块。这并不完全正确。从技术上讲，使用多臂星号是一种形式。但是文档系统，比如phpdoc，依赖于它。是的，我在搜索doxygen的时候确实发现了这个，所以我认为还有一点，我不理解投票结果。这是一个合法的问题。这样评论是有原因的。VS Code FTW