@@ -1,7 +1,10 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< title > Moodle帮助文档: 程序编写准则< / title >
< link rel = "stylesheet" href = "docstyles.css" type = "TEXT/CSS" >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< link rel = "stylesheet" href = "docstyles.css" type = "TEXT/CSS" / >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / >
< / head >
< body bgcolor = "#FFFFFF" >
< h1 > Moodle程序编写准则< / h1 >
@@ -12,25 +15,24 @@
< li class = "spaced" > 所有代码文件应当使用 .php 作为扩展名。< / li >
< li class = "spaced" > 所有模板文件应当使用 .html 作为扩展名。< / li >
< li class = "spaced" > 所有文本文件应当使用Unix风格的文本格式(多数的文本编辑器都有这个选项)。< / li >
< li class = "spaced" > 所有php标记都必须是“完整”标记，譬如< font color = "#339900" > < / font > ... 而不是如< font color = "#339900" > < / font > 的“短”标记。
< li class = "spaced" > 所有php标记都必须是“完整”标记，譬如< font color = "#339900" > < ?php ? > < / font > ... 而不是如< font color = "#339900" > < ? ? > < / font > 的“短”标记。
< / li >
< li class = "spaced" > 所有已经存在的版权声明应当被保留。如果有必要，你可以加入自己的。< / li >
< li class = "spaced" > 每个文件都应当包含主config.php文件。< / li >
< li class = "spaced" > 每个文件都应当检查用户的身份是否正确，可以使用函数require_login()和isadmin()、isteacher()、iscreator()或者isstudent()。< / li >
< li class = "spaced" > 所有访问数据库的操作都应当使用lib/datalib.php中的函数――这样可以兼容更多的数据库服务器。所有的事情都应当是可以用这些函数来完成的，如果遇到必须要写SQL代码的情况，请记住这些代码应当是夸 平台的，且仅仅对你代码中的特定函数(通常在一个lib.php文件中)有效，且代码中有明确的注释 。< / li >
< li class = "spaced" > 不要使用标准全局变量$CFG、$SESSION、$THEME和$USER之外的全局变量。< / li >
< li class = "spaced" > 所有访问数据库的操作都应当使用lib/datalib.php中的函数――这样可以兼容更多的数据库服务器。所有的事情都应当是可以用这些函数来完成的，如果遇到必须要写SQL代码的情况，请记住这些代码应当是跨 平台的，且仅仅对你代码中的特定函数(通常在一个lib.php文件中)有效，且代码中用注释进行明确说明 。< / li >
< li class = "spaced" > 不要建立和 使用标准全局变量$CFG、$SESSION、$THEME和$USER之外的全局变量。< / li >
< li class = "spaced" > 所有变量都应当被初始化或者至少在使用前用isset()或empty()等函数进行检测。< / li >
< li class = "spaced" > 所有字符串都应当可翻译――在"lang/en"目录中创建新的文本文件，字符串应当使用简洁的英文小心 名称，并通过函数get_string()或print_string()来取得。< / li >
< li class = "spaced" > 所有字符串都应当可翻译――在"lang/en"目录中创建新的文本文件，字符串应当使用简洁的英文小写 名称，并通过函数get_string()或print_string()来取得。< / li >
< li class = "spaced" > 所有帮助文件应当可翻译――在"en/help"目录中创建文本文件并且通过helpbutton()函数来调用它们。
< p > 如果需要上传一个帮助文件：
< p > 如果需要上传一个帮助文件：< / p >
< ul >
< li > 对于小的修改，旧的翻译文件仍然可以继续使用时，可以直接进行修改，但你应当通知[email protected] < / li >
< li > 对于大的修改，应当创建新的文件，新文件的文件名是在原文件名的末尾添加一个数字并在以后逐渐增加(如filename2.html)，这样翻译人员就可以方便地知道文件有了一个新的版本。很显然，新的代码和帮助索引文件都必须修改以指向新版本的文件。< / li >
< li > 对于大的修改，应当创建新的文件，新文件的文件名是在原文件名的末尾添加一个数字， < / li >
< / ul >
< / p >
< / li >
< li class = "spaced" > 从浏览器发来的信息(以GET或POST形式发送)都应用了magic_quotes(无论PHP的设置如何)，因此直接将它们插入到数据库中是安全的。所有其它的原始数据(来自文件或数据库的)都必须在插入数据库前使用< font color = "#339900" > addslashes()< / font > 进行预处理。< / li >
< li class = "spaced" > 重要的：Moodle中所有的文本，特别是用户提供的文本，都必须使用format_text()函数来输出。这样就可以确保文本已经被过滤器且正确地清除了过滤信息 。< / li >
< li class = "spaced" > 重要的：Moodle中所有的文本，特别是用户提供的文本，都必须使用format_text()函数来输出。这样就可以确保文本已经正确地过滤 。< / li >
< / ol >
< p > < / p >
< h2 > 编码风格< / h2 >
@@ -40,8 +42,8 @@
< li class = "spaced" > < strong > 变量名< / strong > 应当是容易理解、有含义的小写英文单词。如果确实需要两个或以上的单词，请把它们连在一起，但要保持名称尽可能短。对于数组对象，请使用复数名称。
< p class = "examplecode" > < font color = "#006600" > 好的: $quiz< br / >
好的: $errorstring< br / >
好的: $assignments (for an array of objects )< br / >
好的: $i (but only in little loops )< br / >
好的: $assignments (用于数组 )< br / >
好的: $i (仅用于小型循环 )< br / >
< br / >
坏的: $Quiz < br / >
坏的: $aReallyLongVariableNameWithoutAGoodReason< br / >
@@ -52,31 +54,31 @@
1);< / font > < / p >
< / li >
< li class = "spaced" > < strong > 函数名称< / strong > 应当是简单的英文小写单词，且总是以模块名作为前缀以防止模块之间的冲突。单词之间以下划线分隔。变量如果可能应当总有合理的缺省值。注意在函数名和其后的括号之间没有空格。< br / >
< p class = "examplecode" > < font color = "#007700" > function < / font > < font color = "#0000BB" > forum_set_display_mode< / font > < font color = "#007700" > (< / font > < font color = "#0000BB" > $mode< / font > < font color = "#007700" > =< / font > < font color = "#0000BB" > 0< / font > < font color = "#007700" > )
< p class = "examplecode" > < font color = "#007700" > function < / font > < font color = "#0000BB" > forum_set_display_mode< / font > < font color = "#007700" > (< / font > < font color = "#0000BB" > $mode< / font > < font color = "#007700" > =< / font > < font color = "#0000BB" > 0< / font > < font color = "#007700" > )
{< br / >
global < / font > < font color = "#0000BB" > $USER< / font > < font color = "#007700" > ,
< / font > < font color = "#0000BB" > $USER< / font > < font color = "#007700" > ,
< / font > < font color = "#0000BB" > $CFG< / font > < font color = "#007700" > ;< br / >
< br / >
if (< / font > < font color = "#0000BB" > $mode< / font > < font color = "#007700" > )
< / font > < font color = "#0000BB" > $mode< / font > < font color = "#007700" > )
{< br / >
< / font > < font color = "#0000BB" > $USER< / font > < font color = "#007700" > -> < / font > < font color = "#0000BB" > mode
< / font > < font color = "#0000BB" > $USER< / font > < font color = "#007700" > -> < / font > < font color = "#0000BB" > mode
< / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > $mode< / font > < font color = "#007700" > ;< br / >
} else if (empty(< / font > < font color = "#0000BB" > $USER< / font > < font color = "#007700" > -> < / font > < font color = "#0000BB" > mode< / font > < font color = "#007700" > ))
< / font > < font color = "#0000BB" > $USER< / font > < font color = "#007700" > -> < / font > < font color = "#0000BB" > mode< / font > < font color = "#007700" > ))
{< br / >
< / font > < font color = "#0000BB" > $USER< / font > < font color = "#007700" > -> < / font > < font color = "#0000BB" > mode
< / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > $CFG< / font > < font color = "#007700" > -> < / font > < font color = "#0000BB" > forum_displaymode< / font > < font color = "#007700" > ;< br / >
}< br / >
< / font > < font color = "#0000BB" > $USER< / font > < font color = "#007700" > -> < / font > < font color = "#0000BB" > mode
< / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > $CFG< / font > < font color = "#007700" > -> < / font > < font color = "#0000BB" > forum_displaymode< / font > < font color = "#007700" > ;< br / >
< br / >
}< / font > < / p >
< / li >
< li class = "spaced" > < strong > 语句块< / strong > 必须总是使用大括号(即便是只有一行)。Moodle使用如下风格:
< p class = "examplecode" > < font color = "#006600" > if (< / font > < font color = "#0000CC" > $quiz< / font > < font color = "#006600" > -> < / font > < font color = "#0000CC" > attempts< / font > < font color = "#006600" > )
< p class = "examplecode" > < font color = "#006600" > if (< / font > < font color = "#0000CC" > $quiz< / font > < font color = "#006600" > -> < / font > < font color = "#0000CC" > attempts< / font > < font color = "#006600" > )
{< br / >
if (< / font > < font color = "#0000CC" > $numattempts < / font > < font color = "#006600" > >
< / font > < font color = "#0000CC" > $quiz< / font > < font color = "#006600" > -> < / font > < font color = "#0000CC" > attempts< / font > < font color = "#006600" > )
< / font > < font color = "#0000CC" > $numattempts < / font > < font color = "#006600" > >
< / font > < font color = "#0000CC" > $quiz< / font > < font color = "#006600" > -> < / font > < font color = "#0000CC" > attempts< / font > < font color = "#006600" > )
{< br / >
< / font > < font color = "#0000CC" > error< / font > < font color = "#006600" > (< / font > < font color = "#0000BB" > $strtoomanyattempts< / font > < font color = "#006600" > ,
< / font > < font color = "#CC0000" > "view.php?id=$cm< / font > < font color = "#006600" > -> < / font > < font color = "#CC0000" > id"< / font > < font color = "#006600" > );< br / >
}< br / >
< / font > < font color = "#0000CC" > error< / font > < font color = "#006600" > (< / font > < font color = "#0000BB" > $strtoomanyattempts< / font > < font color = "#006600" > ,
< / font > < font color = "#CC0000" > "view.php?id=$cm< / font > < font color = "#006600" > -> < / font > < font color = "#CC0000" > id"< / font > < font color = "#006600" > );< br / >
< br / >
}< / font > < / p >
< / li >
< li class = "spaced" > < strong > 字符串< / strong > 应当尽可能用单引号定义以提高速度。< br / >
@@ -86,50 +88,64 @@
$var = 'a very, very long string with a '.$single.' variable in it';< br / >
$var = "some $text with $many variables $within it"; < / font > < / p >
< / li >
< li class = "spaced" > < strong > 注释< / strong > 应当使用两个或三个斜线并正确断行 。
< p class = "examplecode" > < font color = "#006600" > function < / font > < font color = "#0000BB" > forum_get_ratings_mean< / font > < font color = "#007700" > (< / font > < font color = "#0000BB" > $postid< / font > < font color = "#007700" > ,
< / font > < font color = "#0000BB" > $scale < / font > < font color = "#007700" > , < / font > < font color = "#0000BB" > $ratings < / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > NULL < / font > < font color = "#007700" > )
< li class = "spaced" > 实用的 < strong > 注释< / strong > 应当尽可能填写，用以解释代码流程和函数与变量的功能 。
< ul >
< li > 每个函数和类都应该使用流行的 < a target = "_blank" href = "http://www.phpdoc.org/" > phpDoc格式 < / a > 编写，以便自动生成代码文档。 < / li >
< li > 内嵌注释应使用 // 风格，并且整齐布局，使其能融入代码中并和代码对齐。
< / li >
< / ul >
< p class = "examplecode" > < font color = "#FF8000" >
/**< br / >
* The description should be first, with asterisks laid out exactly< br / >
* like this example. If you want to refer to a another function,< br / >
* do it like this: {@link clean_param()}. Then, add descriptions < br / >
* for each parameter as follows.< br / >
*< br / >
* @param int $postid The PHP type is followed by the variable name< br / >
* @param array $scale The PHP type is followed by the variable name< br / >
* @param array $ratings The PHP type is followed by the variable name< br / >
* @return mixed< br / >
*/< / font > < br / >
< font color = "#006600" > function < / font > < font color = "#0000BB" > forum_get_ratings_mean< / font > < font color = "#007700" > (< / font > < font color = "#0000BB" > $postid< / font > < font color = "#007700" > ,
< / font > < font color = "#0000BB" > $scale< / font > < font color = "#007700" > , < / font > < font color = "#0000BB" > $ratings< / font > < font color = "#007700" > =< / font > < font color = "#0000BB" > NULL< / font > < font color = "#007700" > )
{< br / > < / font >
< font color = "#007700" > if (!< / font > < font color = "#0000BB" > $ratings< / font > < font color = "#007700" > )
{< br / >
< / font > < font color = "#FF8 000" > /// Return the mean rating of a post given
to the current user by others. < br / >
/// Scale is an array of possible ratings in the scale< br / >
/// Ratings is an optional simple array of actual ratings (just integers)< br / >
< br / >
< / font > < font color = "#007700" > if (!< / font > < font color = "#0000BB" > $ratings< / font > < font color = "#007700" > )
{< br / >
< / font > < font color = "#0000BB" > $ratings
< / font > < font color = "#007700" > = array(); < / font > < font color = "#FF8000" > //
< / font > < font color = "#0 000BB " > $ratings
< / font > < font color = "#007700" > = array(); < / font > < font color = "#FF8000" > //
Initialize the empty array< / font > < font color = "#007700" > < br / >
if (< / font > < font color = "#0000BB" > $rates
< / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > get_records< / font > < font color = "#007700" > (< / font > < font color = "#DD0000" > "forum_ratings"< / font > < font color = "#007700" > ,
< / font > < font color = "#DD0000" > "post"< / font > < font color = "#007700" > , < / font > < font color = "#0000BB" > $postid< / font > < font color = "#007700" > ))
< / font > < font color = "#0000BB" > $rates
< / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > get_records< / font > < font color = "#007700" > (< / font > < font color = "#DD0000" > "forum_ratings"< / font > < font color = "#007700" > ,
< / font > < font color = "#DD0000" > "post"< / font > < font color = "#007700" > , < / font > < font color = "#0000BB" > $postid< / font > < font color = "#007700" > ))
{< br / >
< / font > < font color = "#FF8000" > //
< / font > < font color = "#FF8000" > //
Process each rating in turn< / font > < font color = "#007700" > < br / >
foreach
(< / font > < font color = "#0000BB" > $rates < / font > < font color = "#007700" > as < / font > < font color = "#0000BB" > $rate< / font > < font color = "#007700" > )
(< / font > < font color = "#0000BB" > $rates < / font > < font color = "#007700" > as < / font > < font color = "#0000BB" > $rate< / font > < font color = "#007700" > )
{< / font > < br / >
....etc < / p >
< / li >
< li class = "spaced" > < strong > 换行< / strong > 可以被大方地使用——把东西分散开看起来会比较清楚。一般情况下，在花括号和普通命令之间应当有一个换行符，但在花括号和变量或函数之间可以没有换行符:< br / >
< p class = "examplecode" > < font color = "#007700" > foreach (< / font > < font color = "#0000BB" > $objects
< / font > < font color = "#007700" > as < / font > < font color = "#0000BB" > $key < / font > < font color = "#007700" > => < / font > < font color = "#0000BB" >
< p class = "examplecode" > < font color = "#007700" > foreach (< / font > < font color = "#0000BB" > $objects
< / font > < font color = "#007700" > as < / font > < font color = "#0000BB" > $key < / font > < font color = "#007700" > => < / font > < font color = "#0000BB" >
$thing< / font > < font color = "#007700" > )< / font > < font color = "#006600" > {< br / >
< / font > < font color = "#007700" > < / font > < font color = "#0000BB" > process($thing);< / font > < font color = "#006600" >
< / font > < font color = "#007700" > < / font > < font color = "#0000BB" > process($thing);< / font > < font color = "#006600" >
< br / >
} < br / >
< br / >
< / font > < font color = "#007700" > if (< / font > < font color = "#0000BB" > $x < / font > < font color = "#007700" > ==
< / font > < font color = "#0000BB" > $y< / font > < font color = "#007700" > )< / font > < font color = "#006600" >
< / font > < font color = "#007700" > if (< / font > < font color = "#0000BB" > $x < / font > < font color = "#007700" > ==
< / font > < font color = "#0000BB" > $y< / font > < font color = "#007700" > )< / font > < font color = "#006600" >
{< br / >
< / font > < font color = "#007700" > < / font > < font color = "#0000BB" > $a
< / font > < font color = "#007700" > < / font > < font color = "#0000BB" > $a
< / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > $b< / font > < font color = "#007700" > ;< / font > < font color = "#006600" > < br / >
} else if (< / font > < font color = "#0000BB" > $x < / font > < font color = "#007700" > ==
} else if (< / font > < font color = "#0000BB" > $x < / font > < font color = "#007700" > ==
< / font > < font color = "#0000BB" > $z< / font > < font color = "#006600" > ) {< br / >
< / font > < font color = "#007700" > < / font > < font color = "#0000BB" > $a
< / font > < font color = "#007700" > < / font > < font color = "#0000BB" > $a
< / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > $c< / font > < font color = "#007700" > ;< / font > < font color = "#006600" > < br / >
} else {< br / >
< / font > < font color = "#007700" > < / font > < font color = "#0000BB" > $a
< / font > < font color = "#007700" > < / font > < font color = "#0000BB" > $a
< / font > < font color = "#007700" > = < / font > < font color = "#0000BB" > $d< / font > < font color = "#007700" > ;< / font > < font color = "#006600" > < br / >
} < / font > < / p >
< / li >
@@ -141,17 +157,18 @@
< li class = "spaced" > 包含着模块中数据实例的主表格必须和模块同名(譬如< strong > widget< / strong > )，并且至少包含如下字段:
< ul >
< li > < strong > id< / strong > - 如上一条所述< / li >
< li > < strong > course< / strong > - 每个实例所属的课程< / li >
< li > < strong > course< / strong > - 每个实例所属的课程id < / li >
< li > < strong > name< / strong > - 每个实例的完整名称< / li >
< / ul >
< / li >
< li class = "spaced" > 与模块相关的其它表格的命名规则是：如果它包含的信息是关于“thing”的，则它的名字应当是< strong > widget_things< / strong > (注意采用复数形式)。< / li >
< li class = "spaced" > 与模块相关的其它表格的命名规则是：如果它包含的信息是关于“things ”的，则它的名字应当是< strong > widget_things< / strong > (注意采用复数形式)。< / li >
< li class = "spaced" > 字段名称应当简短，与变量名的规则相同。< / li >
< li class = "spaced" > 在可能的情况下，包含着对其它表格(如< strong > widget< / strong > )引用的字段应当命名为< strong > widgetid< / strong > 。(注意这是个新约定，有一些老的表格并未遵守)< / li >
< li class = "spaced" > 布尔字段应当使用小整数类型(如INT4)并存储0或1，这样就可以在需要时扩展它。< / li >
< li class = "spaced" > 布尔字段应当使用小整数类型(如INT4)并存储为 0或1，这样就可以在需要时扩展它。< / li >
< li class = "spaced" > 多数的表格应当有一个< strong > timemodified< / strong > 字段(INT10)，并用PHP的< strong > time< / strong > ()函数取得的当前时间戳来更新它。< / li >
< / ol >
< hr / >
< p align = "CENTER" > < font size = "1" > < a href = "." target = "_top" > Moodle帮助文档< / a > < / font > < / p >
< p align = "CENTER " > < font size = "1" > Version: $Id$< / font > < / p >
< / body >
< p align = "center " > < font size = "1" > Version: $Id$< / font > < / p >
< / body >
< / html >
lonecatz