缺少文件文档注释？

Question

我使用了 drupal coder 模块来检查我的代码，并且总是将缺少文件文档作为错误。我使用了以下文件文档注释，但仍然显示错误。你能指导我我做错了什么吗？编辑:

 <?php

/**
 * @file
 * Description
 */


/**
 * Implements hook_menu().
 *
 * Description
 *
 * @return array An array of menu items
 */
function hook_menu() {
 //My code
}

Answer 1

文件的典型前 15 行：

<?php

/**
 * @file
 * Description of what this module (or file) is doing.
 */

/**
 * Implements hook_help().
 */
function yourmodule_help($path, $arg) {
  // or any other hook...
}

别忘了用 /** 注释你文件的第一个函数，否则编码器会认为你的 @file 注释是你第一个函数的注释。

缺少文件文档注释？

Missing file doc comment?

drupal

codesniffer