php - 在文件开头包含函数列表的好习惯

Question

在 PHP 文件的开头包含函数列表（在注释部分中）是一种好习惯吗？

Answer 1

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

Answer 2

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

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

阅读此处了解有关 documentor (PHPDOC) 的 php 评论标准的最佳实践。

Jeff atwood 的无评论编码和When Good Comments Go Bad帖子有助于评论策略。