Cabeçalho padrão de um pacote

Da AMADIS

(Diferença entre edições)
 
Linha 1: Linha 1:
-
[[categoria:Documentação]]
+
#REDIRECT [[Como documentar o código do AMADIS]]
-
Este é um cabeçalho padrão que deve acompanhar todos os arquivos de um pacote. Assim poderemos identificar de maneira mais a sua estrutura e distribuição, através da documentação.
+
-
 
+
-
/**
+
-
  * Comentário sobre o funcionamento ou objetivo da classe ou script
+
-
  *
+
-
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+
-
  * @access public or private
+
-
  * @package AMADIS
+
-
  * @subpackage AMPackage
+
-
  * @version 1.0
+
-
  * @author Programer Name <name@email.org>
+
-
  * @example  /path/to/example.php  description
+
-
  * @see ClassName1,ClassName2
+
-
  */
+
-
 
+
-
As [[Tags do phpDocumentor|tags]] @example, @license e @see não são obrigatórias, elas são interessantes para incremento de sua documentação e para melhor navegação pelas classes que são correspondentes.
+

Edição actual desde as 04h16min de 21 de Junho de 2006

  1. REDIRECT Como documentar o código do AMADIS
Ferramentas pessoais
Parceiros
















SourceForge.net Logo

Supported by Cenqua