A.2. 风格指南

A.2.1. 编码风格

Solar类遵循PEAR编码标准,当然还是有点小的偏差。在PEAR中,只有私有成员才以下划线开始;在Solar中,私有和受保护成员都以下划线开始。

<?php
public    $public;
protected $_protected; // in PEAR, this would be $protected instead
private   $_private;

A.2.2. 解决问题的风格

在每个Solar类中,我们崇尚简单、易于测试、易于解释的解决方案。我们喜欢快的执行速度,但是比起快速但晦涩难懂的程序风格,我们更倾向于慢一点但是简单的风格。

当复杂代码无可避免时,我们会给出详细注释和注释语句。我们了解到有一些可怜的家伙必须要知道代码是怎么工作的,所以我们花了一点额外的时间写注释以便让大家知道正在发生的事情。

A.2.3. 命名空间

目前,Solar使用PHP 5.3之前的PEAR风格的伪命名空间(即在类前加工作区(vendor)前缀)。这不会影响你在Solar中使用命名空间。Solar将来的版本可能会使用PHP 5.3正式的命名空间。

A.2.4. 行内文档风格

Solar为每个类、属性、方法都使用了PHP Documentor块。这使得生成类文档非常容易,使用使用Solar的make-docs命令行工具就会自动生成。