next up previous contents index
Next: CVS Up: PET Previous: Principy cachování v Internetu

Programátorské konvence

Autoři projektu se snažili, aby byl kód PETu přehledný a pokud možno snadno čitelný. Z toho důvodu vznikly na samém počátku vývoje a návrhu PETu následující konvence, které se dařilo více či méně plnit.

 Jména funkcí jednotlivých modulů začínají na jméno daného modulu, následované podtržítkem a vlastním jménem funkce. Tedy např. funkce icp_findnode(..) patří do modulu ICP. Implementace každého modulu je uvedena v samostatném souboru.

Snažili jsme se, aby byl před začátkem každé funkce komentář, který informuje o tom, co daná funkce dělá a vysvětluje nejdůležitější parametry funkce. Měl by též informovat o návratové hodnotě funkce. Naprostá většina komentářů je v anglickém jazyce, to proto že autoři PETu chtějí tento projekt otevřít široké mase Internetových vývojářů. U složitějších částí programu, by měly být uvedeny základní myšlenky a principy implementace.



 

Stanislav Pavlicek
2000-06-12