Dokumentowanie aplikacji

Z PHPEdia.pl

Dlaczego jest potrzebne?

Pamięć jest zawodna. Kod, niezależnie od tego, jak dobrze byłby sformatowany, zaprojektowany i przemyślany, dla osoby, która go nie pisała, lub po dłuższym czasie, potrafi być bardzo trudny do zrozumienia, zmodyfikowania lub użycia.

Przykład dokumentacji kodu

<?php
/**
 * Opis pliku
 */
 
/**
 * Opis klasy
 */
class Klasa
{
   /**
    * Opis funkcji
    */
   function funkcja()
   {
 
   }
}
?>

Zobacz także

• Standardy kodowania
• Krok2 - Jak pisać
• phpDocumentor

To jest tylko zalążek artykułu. Jeśli możesz, rozbuduj go.