文档语法

当编写在线的代码文档时,很难为代码确定一个统一的标准.我们在这里给出一些简单的规则,供大家使用:

·                                 函数和钩子名称应使用粗体.例如:hook_perm()

·                                 文件名称应该使用斜体.例如: uc_store.module

·                                 变量名称名称应使用粗体.例如: $op

·                                 对变量类型的引用应该使用斜体.例如: string

·                                 代码样例应该使用PHP标签,以进行高亮显示.对于输入格式设置为PHP的页面,使用pre标签来显示代码样例:<pre style="border: solid 1px #bbb; padding: 5px;"></pre>

·                                 菜单标题应该使用粗体和更大字体。例如:Administer(管理) > Site building(站点构建) > Blocks(区块)

 

对于钩子文档,当你使用表格来显示键值时,这里有一组CSS class集供你使用。(当然,你也可以在别的地方使用这一表格)。将页面的输入格式设为Full HTML,对表格使用类"array_keys",对于标题行使用"header",对于键型单元格使用"key",对于数据类型的单元格使用"type",对于描述型单元格使用"value"。对于可选的值,在键的名称后面加一个*,并在整个表格的最下面加上一行,里面包含以下内容,这里使用斜体:*键是可选的。对于可选键的描述中,应该给出当被忽略时,所使用的默认值。

相关链接:Think in Drupal

http://www.ubercart.org/docs/developer/239/documentation_synatx

Drupal版本: