Documentare il codice

[bonzox]

Che tecniche usate per documentare il vostro codice e renderlo il più riusabile possibile?

[tremalnaik_sal]

doxigen

[Leilond]

Io programmo quasi completamente ad oggetti e ogni methodo della mia classe parte con qualcosa del genere

// Public method mioMetodo
// @returns string
/*
*  This method process this and that producing this result
*  @param string $var: contains this information
*  @param mixed $var2: contains this information or that
*/
  public function mioMetodo($var,$var2) 

Cerco poi di dare alle variabli nomi più "auto-commentanti" possibile, aggiungendo singole righe di commento con "// Start XXX elaboration" e "// End XXX elaboration" per descrivere il senso di blocchi di programma

Occasionalmente, in punti particolarmente complessi commento più ampiamente, ma solitamente considero questa necessità come il segnale che mi sono incartato troppo e devo semplificare