|
CodingStandards
Kódolási, elnevezési és dokumentálási szabályok a projektben
Phase-Requirements, Phase-Implementation Kódolási, elnevezési és dokumentálási szabályokKódolási szabályokA 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
Dokumentálási szabályokA 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. |