缺少文件文档注释？答案

【问题标题】：Missing file doc comment?缺少文件文档注释？
【发布时间】：2015-12-04 01:14:25
【问题描述】：

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

 <?php

/**
 * @file
 * Description
 */


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

【问题讨论】：

您是否尝试将 php 版本添加到您的文件中，它看起来像 /* PHP 5 */
你能给我举个例子吗？我检查了 drupal 标准模块api.drupal.org/api/drupal/modules!comment!comment.module/… 并且还有一个缺少文件注释的问题。可能是codesniffer的问题？
我只是读了一篇博客blog.rajatpandit.com/2009/10/01/…
添加了 PHP 版本 5 但仍然存在问题

标签： drupal codesniffer

【解决方案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 注释是你的第一个函数的注释。

【讨论】：

我无权这样做。请在下面查看我的文件代码：<?php /** * @file * Description of file */ /** * Implements hook_menu(). * * Description of function * * @return array An array of menu items */ function lr_social_login_menu() { //My code }