在文件开头包含功能列表的好习惯

Question

在PHP文件的开头包含一个函数列表（在注释部分中）是不错的做法？

Answer 1

没有。 一个好的做法是使用 - PHPDoc。

Answer 2

是的，它有助于了解此文件正在使用的功能。

您还应该在实际功能代码之前注释掉哪些参数和返回类型。

阅读here，了解关于文档编制器（PHPDOC）的php评论标准的最佳做法。

Jeff atwood的coding without comments和When Good Comments Go Bad帖子有助于评论策略。