My favorites | Sign in
Project Home Downloads Wiki Issues Source
READ-ONLY: This project has been archived. For more information see this post.
Search
for
CodingStandards  
Kódolási, elnevezési és dokumentálási szabályok a projektben
Phase-Requirements, Phase-Implementation
Updated Apr 30, 2007 by prezdes...@gmail.com

Kódolási, elnevezési és dokumentálási szabályok

Kódolási szabályok

A projekt kódolása során igazodni kell a C++ kódolási szabványhoz, mely megtekinthető a http://www.possibility.com/Cpp/CppCodingStandard.html weboldalon.

Elnevezési szabályok

  • A fájlokban egy egy osztályt (interfészt) kell tárolni
  • az osztályok (vagy interfészek) első betűje p kell hogy legyen
  • A fájl neve meg kell egyezzen a benne található osztály vagy interfész nevével
  • A fájlok, változók, osztályok, interfészek, metódusok nevét CamelCase formátumban kell írni
  • A konstansok nevét végig nagybetűvel kell írni
  • Minden változó, osztály, interfész, metódus neve angol kell hogy legyen!

Dokumentálási szabályok

A projektben a PHPDocumentor dokumentálási szabályai érvényesek, minél jobban ki kell ezeket használni. Fájl elején a következő tag-ek kell szerepeljenek:

<?php
/**
 * Short description of the class/interface
 *
 * A longer description of the class/interface
 *
 * @author Author's name <author@email-address.tld>
 * @package pcms/pframework
 * @subpackage subpackagename
 */

Megfelelően kell definiálni a metódusokat és adattagokat is.

Powered by Google Project Hosting