AKSW - Projects/OntoWiki/CodingStyleGuide

2008-01-22 13:35:42

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2008-01-22 13:35:42 and 2008-01-22 15:20:34

Deletions:

Header Comment Blocks

OntoWiki is licensed under GPL, so a GPL header must go into each file:
/*
* afile.php
* Encoding: utf-8
* Copyright © 2007, Onto Wiki project team
* This file is part of Onto Wiki.
* Onto Wiki is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* Onto Wiki is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with Onto Wiki; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110–1301 USA

A short description of the file or class.
@package: Package Name
@author: Author Name
@version: $Id$
/

2008-01-22 12:51:19

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2008-01-22 12:51:19 and 2008-01-22 13:35:42

Additions:

Every class starts with the Erfurt prefix followed by an underscore.
The second part of the name is the name of the package the class belongs to (in this case examplepackage).
The third part of the name is the real name of your class (in this case ExampleClass).
The name of a class and it's position in the file system should directly adhere, i.e. for the above example, the corresponding class should be located in Erfurt/ExamplePackage/ExampleClass.php.
Each file correspondends to exactly one class.

Inline Documentation

Classes

Every class should be documented as followed:
* The first sentence is the short description followed by a break.
* The second clause and all following sentences are for a detailed description of
* the class. Feel free to document your class and the function of it as detailed as
* possible, such that other developers or end-users have a good basis.
* @package examplepackage
* @author Philipp Frischmuth <philipp@frischmuth24.de>
* @author Maybe Another Author <with.another@email.address>
* @copyright Copyright (c) <YEAR_OF_CREATION> – <CURRENT_YEAR>, {@link http://aksw.org AKSW}
* @license http://opensource.org/licenses/gpl-license.php GNU General Public License (GPL)
* @see http://example.com/doc/ExternalLibraryClass.html
* @version $Id: $
class Erfurt_ExamplePackage_ExampleClass extends External Library Class {
// ..
Please note the following:

The first sentence of the comment is always the short description.
Each following sentence belongs to the detailed description of the class.
Please insert an empty line between short description and detailed description and between detailed description and following tags.
Always use the @package tag. In case the class belongs to the default package use @package erfurt.
Use a new @author tag for each author.
Use the @copyright tag as above, but just use the current year in case current year and year of creation are equal.
Always use the @license tag, for we do without the GPL preamble.
In case your class extends or implements a unknown class (e.g. the class/interface belongs to an external library) use the @see tag together with an URL pointing to the documentation of that class or interface.
Use the @version tag as above, but also set the svn:keywords property if you are adding a new class: svn propset svn:keywords Id Erfurt / Example Package / Example Class.php

Deletions:

Every class starts with the Erfurt prefix followed by an underscore
The second part of the name is the name of the package the class belongs to (in this case examplepackage)
The third part of the name is the real name of your class (in this case ExampleClass)
The name of a class and it's position in the file system should directly adhere, i.e. for the above example, the corresponding class should be located in Erfurt/ExamplePackage/ExampleClass.php
Each file correspondends to exactly one class

2007-08-30 13:51:07

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2007-08-30 13:51:07 and 2008-01-22 12:51:19

Additions:

Class Naming

In order to make classes auto-loadable, please use the following scheme for class-names:
class Erfurt_ExamplePackage_ExampleClass {
// ...

Every class starts with the Erfurt prefix followed by an underscore
The second part of the name is the name of the package the class belongs to (in this case examplepackage)
The third part of the name is the real name of your class (in this case ExampleClass)

Please also note the following:

The name of a class and it's position in the file system should directly adhere, i.e. for the above example, the corresponding class should be located in Erfurt/ExamplePackage/ExampleClass.php
In case a class should belong to the default package (erfurt) the class would be named as followed:

class Erfurt_ExampleClass {
// ...

Each file correspondends to exactly one class

2007-08-30 13:50:46

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2007-08-30 13:50:46 and 2007-08-30 13:51:07

No differences.

2007-07-26 12:40:46

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2007-07-26 12:40:46 and 2007-08-30 13:50:46

Additions:

Operators

All operators have to be surrounded with spaces.
$foo = $this->getFooVar();
$bar = $this->getBarVar() . ' appended to bar';
for ($i = 0; $i < 100; ++$i) {

echo ($i + 7 % 3);

2007-07-26 12:40:27

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2007-07-26 12:40:27 and 2007-07-26 12:40:46

Additions:

// now we can safely assume an array

Deletions:

// now we can safely assue an array

2007-07-26 00:30:23

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2007-07-26 00:30:23 and 2007-07-26 12:40:27

Additions:

// now we can safely assue an array
foreach ($values as $val) {

// ...

Deletions:

// ...

2007-06-26 15:58:25

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2007-06-26 15:58:25 and 2007-07-26 00:30:23

Additions:

Type Hinting

You are highly encouraged to use type hinting that was introduced with PHP 5. Type hinting allows you to request function parameters passed to be of a certain type. If a wrong type is passed, PHP throws a runtime error. Type hinting only works with objects or arrays, i.e. you can specify the exact class name of which passed objects need to be an instance or you use the type array.
public function myFunc(RDFSClass $class, array $values) {

// ...

2007-06-26 15:57:49

Comparison for /Projects / Onto Wiki / Coding Style Guide of 2007-06-26 15:57:49 and 2007-06-26 15:58:25

Additions:

OntoWiki is licensed under GPL, so a GPL header must go into each file:

Deletions:

Ontwo Wiki is licensed under GPL, so a GPL header must go into each file: