Php 代码内文档（注释）最常见/最喜欢的语法？

我已经用Notepad++编写PHP多年了，但今天我下载了EclipseIDE。它的一个特性是自动完成某些语法模式，例如注释。我已经看到了很多将注释和文档实现到php文件中的不同方法，所以现在我开始思考，是否应该遵循Eclipse建议的语法

以下是我的意思：

你觉得怎么样

---

Martti Laine

它是phpdoc格式，一种使用注释自动记录代码的方法

---

这是phpdoc格式，一种使用注释自动记录代码的方法

---

Eclipse似乎选择了可能是PHP项目最常见的解决方案，我很高兴推荐elements，它是记录各种类、方法、方法参数等的好方法，并且提供了跟踪待办事项、将函数/方法标记为已弃用等的方法

此外，您当然可以使用phpdoc命令行工具生成HTML、PDF、CHM格式的文档

---

您可以在上找到更多信息并查看所需的语法。

Eclipse似乎正在选择可能是PHP项目最常见的解决方案，我很高兴地推荐元素，这是记录各种类、方法、方法参数等的一种很好的方式，并提供了一种跟踪待办事项的方法，将函数/方法标记为已弃用等

此外，您当然可以使用phpdoc命令行工具生成HTML、PDF、CHM格式的文档

---

您可以在上找到更多信息并查看所需的语法。

Eclipse最好使用herdoc/phpdoc注释，然后将其编译成文档。尝试编写一个函数，然后在上面添加一个/**注释，您将看到ecplise自动在注释中添加函数参数

如果您看一看JavaAPI，就会发现这种文档是根据这种注释风格编译而成的

---

如果你认为你永远不会把你的注释编译成文档，那么就不要觉得受它束缚，代码中的额外注释总是有用的。然而，这是一个文档标准，所以这不是一件坏事。我只倾向于使用这种风格的注释，因为我知道很多其他人会查看这些内容。

Eclipse最好使用herdoc/phpdoc注释，然后将其编译成文档。尝试编写一个函数，然后在上面添加一个/**注释，您将看到ecplise自动在注释中添加函数参数

如果您看一看JavaAPI，就会发现这种文档是根据这种注释风格编译而成的

---

如果你认为你永远不会把你的注释编译成文档，那么就不要觉得受它束缚，代码中的额外注释总是有用的。然而，这是一个文档标准，所以这不是一件坏事。我只倾向于对我知道很多其他人会关注的事情使用这种评论方式。

正如其他人所指出的，对phpdoc使用这种评论是非常有价值的。但我认为这不仅仅是关于生成文档，而且还可以让您更容易地编写代码。一些IDE（至少是Netbeans）使用phpdoc注释来提供比其他方法更好的自动完成功能。

正如其他人所指出的，对phpdoc使用这种注释是非常有价值的。但我认为这不仅仅是关于生成文档，而且还可以让您更容易地编写代码。一些IDE（至少是Netbeans）使用phpdoc注释来提供比其他方法更好的自动完成特性