Zo langzamerhand wil ik toch mijn PHP scriptjes beter gaan omscrijven in de source van een php document. Dit om de scripts voor me zelf, maar zeker ook voor anderen beter toegankelijk te maken.
Standaard zijn er af “afspraken” over hoe je het beste je aan je php files comments kunt toevoegen.
Zo zijn er bepaalde tags:
@author @link @var
etc…
Ook de manier van comments schrijven zie je veel terug komen…
bijvoorbeeld:
[code:1:f3cee9be40]
/**
Page-level DocBlock
@package unfinished
@todo finish the functions on this page /
/*
function datafunction
@todo make it do something
*/
[/code:1:f3cee9be40]
Zijn er handige handige tooltjes voor Mac of PC om zulke comments toe te voegen aan je PHP scripts, of is er hier misschien een glossary voor aanwezig binnen BBEdit?
Misschien zijn er al mensen de filters hebben geschreven met ‘grep pattern searching’ voor BBEdit.
Ik wil graag mijn scriptjes gaan beschrijven in ‘comments’ maar ik weet niet waar ik me allemaal aan moet houden. Is er iemand hier die me opweg kan helpen ?
phpDocumentor kan aan de hand van deze tags documentatie van je PHP-scripts aanmaken. Handleiding en tutorials staan op [url]http://www.phpdoc.org/[/url]
Ik weet niet of er tools bestaan om deze tags toe te voegen aan je scripts. Zelf doe ik het altijd handmatig. Maar wellicht staat er op bovengenoemde site meer informatie.
ik gebruik op mijn werk Zend Development Environment om te ontwikkelen en daarbij kan je dus ook die codes plaatsen (Zend pikt ze dan ook vanzelf op, zeer handig voor functies en o.o. programmeren).
voor vast functies heb je bijv. ook :
[code:1:f3ecec0664]
/**
@return (type wat de functie terug geeft; Int, String, Object, etc)
@param (type van parameter) (parameternaam)
@desc (Omschrijving van wat de functie doet)
*/
[/code:1:f3ecec0664]
voorbeeldje :
[code:1:f3ecec0664]
/**
* @return Void
* @param Instance of mysql_database $db_object
* @param String $new_title
* @param Text $new_description
* @param Int $new_order
* @param Int $new_parent
* @desc Updates the database and the object with given values
*/
function update_album($db_object, $new_title, $new_description, $new_order) {
$str_update = "UPDATE " . TBL_ALBUM . " SET ";
$str_update .= TBL_ALBUM_TITLE . " = ’ " . $new_title . "’, “;
$str_update .= TBL_ALBUM_DESCRIPTION . " = '” . $new_description . "’, ";
$str_update .= TBL_ALBUM_ORDER . " = " . $new_order . " ";
$str_update .= "WHERE " . TBL_ALBUM_ID . " = " . $this->album_id;
Bedankt voor jullie reactie, maar ik ben er zeker nog niet uit.
Ik ga in ieder geval ‘PHPDoc’ proberen te instaleren, Het zend gebeuren is mij te prijzig, aangezien ik dit uit mijn eigen zak moet betalen, daarnaast werk ik ook het liefst met BBEdit.
Waarschijnlijk moet ik toch gewoon beginnen om dit met de hand te doen, minder prijzige tools hiervoor komen misschien later op de markt.
