phpdoc przyklad jak uzyc funkcji/metody Opcje

[marcio]

Elo mam dylemat chce sobie zaczac dokumentowac kod...juz mam wszystko zrobione...jednak mam pewne metody gdzie samo @access,@param,@return mi nie wystarcza chcialbym w zrodlo pliku w ktorym sie znajduje klasa podac maly przyklad uzycia metody.
Czy robi sie to za pomoca: http://manual.phpdoc.org/HTMLSmartyConvert...xample.pkg.html czy http://manual.phpdoc.org/HTMLSmartyConvert...source.pkg.html

Pytam bo nie jestem pewny...

[Crozin]

Nawet nie jestem teraz na 100% pewien ale chyba powinieneś używać 4-ech spacji, zamiast tabulatora, <code /> możesz sobie darować bo samo wcięcie już spełnia tę funkcję. <?php i ?> też są zbędne. Samą dokumentację też można by pisać po angielsku - wygodniej tak jest.

[PHP] pobierz, plaintext 
	/**
	 * Ustawia nam dla danej kolumny odpowiedni typ w html.
	 *
	 * Przykład użycia np kolumna news_author w $this -> db_fields_equivalent jest typu text chcemy ja zmienic na textarea:
	 *
	 *     $zrobCosTam->dsadasda();
	 *     $instance -> set_equivalent('news_author', 'textarea');
	 *     $zrobCosTam->dsadasda();
	 *
	 * Bla bla bla bla - dalszy opis. 
	 *
	 * @param string $key Nazwa pola
	 * @param string $type
	 */
	public function set_equivalent($field, $type) {
		if(array_key_exists($field, $this -> db_fields_equivalent)) {
			$this -> db_fields_equivalent[$field] = $type;
		}
	}
[PHP] pobierz, plaintext 

PS. W PHP stosuje się konwencję camelCase, czyli setEquivalent(), a @access jest zbędne ponieważ sam język to określa przy deklaracji metody.