You are here

Drupal专业开发指南 第21章 文档例子

让我们从头到脚仔细的看看一个模块的基干,同时将不同类型的文档从中选出来进行单独说明。

    模块的第2行(在<?php开始标签之后),应该包含一个CVS标签,用来追踪文件的版本号:
 
// $Id$
 
    当把代码提交到CVS以及使用CVS更新代码(CVS的代码是最新的)时,系统将会自动对这一标签进行解析和扩展。之后,它将自动地变成下面的样子:
 
// $Id: comment.module,v 1.617.2.2 2008/04/25 20:58:46 goba Exp $
 
    在本章后面,你将学到更多关于如何使用CVS的知识。
 
    在声明函数以前,你需要花点功夫为模块写点文档,介绍模块能做什么,文档的格式如下所示:
 
/**
 * @file
 * One-line description/summary of what your module does goes here.
 *
 * A paragraph or two in broad strokes about your module and how it behaves.
 */
 
为常量编写文档
    PHP常量全部都应该大写,可以使用下划线分隔单词。当定义PHP常量时,最好能够解释一下它们是用来做什么的,如下面的代码片段所展示的这样:
 
/**
 * Role ID for authenticated users; should match what's in the "role" table.
 */
define('DRUPAL_AUTHENTICATED_RID', 2);
 老葛的Drupal培训班 Think in Drupal

Drupal版本: