第四次小组讨论 （代码规范）

进度：
前端首页至具体科目页面设计基本完成。
连接数据库。
完成登录密码验证。

页面如下

点击登录/注册

点击这里

学院界面

课程界面

下一步计划：
完成科目搜索功能。
改进科目展示表格，使更容易查找科目。
在“联系我们”界面的地图改为API。
完善注册登录系统。



项目中采用的一些规范

1，错误报告开启
错误报告是在PHP中一个非常有用的功能，应同时在开发阶段启用。 这可以帮助我们确定我们的代码中的问题。 最常用的功能是“E_ALL”，这有助于发现所有的警告和严重错误。
在代码投入使用前应该关闭这个功能提示，否则会在浏览器上的暴漏所有潜在错误及警告。
 
2，使用DRY原则
‘Do not Repeat Yourself’，DRY原则指的是不要重复你的代码.。 这个概念是一个非常有用的编程概念，可硬应用在任何编程语言，如Java，C＃或PHP均可以。 使用DRY原则，确保在程序中没有冗余的代码。
 
冗余代码：
$db_host = ' localhost ';
$db_user = ' mysqladmin_uid ';
$db_password = ' mysqladmin_pwd ';
$db_database = ' DB_NAME ';
$mysql = mysql_connect($db_host, $db_user, $db_password);
mysql_select_db($db_database);
 
优化之后：
$mysql = mysql_connect ( 'localhost', 'mysqladmin_uid', 'mysqladmin_pwd' );
mysql_select_db( 'DB_NAME' ) or die( "Sorry !! No database selected!");
 
3，适当的使用缩进及空格
在使用任何一种编程语言编写代码时，必须确保代码在需要的地方提供在必要适当的缩进和足够的空格。 以增加了代码的可读性，用更有效的方式管理代码。
 
 
4，使用有意义和一致的命名标准
建议使用下划线式命名。在这种方法中，我们把每两个词之间的下划线（“_”）。
 
 
5，避免深层嵌套
使用任何开发语言，多级嵌套降低了代码的可读性。 任何开发者都应应避免使用深层嵌套。
 
深层嵌套：
<?php
class MyClass {
public function method_name($arg_name) {
if (is_writable ( $folder )) {
if ($fp = fopen ( $file_location_path, 'w' )) {
if ($stuff = extractSomeConditionalStuff ()) {
if (fwrite ( $fp, $stuff )) {
// ...
} else {
return false;
}
} else {
return false;
}
} else {
return false;
}
} else {
return false;
}
}
}
?>
 
 
优化之后：
function method_name (String arg_name) {
// ...
if (! is_writable ( $folder )) {
return false;
}
if (! $fp = fopen ( $file_location_path, 'w' )) {
return false;
}
if (! $stuff = extractSomeConditionalStuff ()) {
return false;
}
if (fwrite ( $fp, $stuff )) {
// ...
} else {
return false;
}
}
 
6，添加应有的注释
开发中，请确保你的源代码中有足够的行内注释。 这是一个应该遵守的标准做法。 这有助于深入分析代码，因为通常情况下，负责编码的人不会一直保持不变。 即使同一个人被要求在代码中进行一些简单的修改，行内的注释总是会有助于理解当时编写代码是用来做什么的。




7，避免复制已有变量
将预定义变量复制到具有较小的名字的局部变量不是一个好的编程习惯。 这对应用程序的性能产生不利影响。
 
复制变量：
$desc = strip_tags($_POST['PHP description']);
echo $desc;
 
优化之后：
echo strip_tags($_POST['PHP description']);