Formato commento PHP: generato automaticamente o creato dall'utente?

StackOverflow https://stackoverflow.com/questions/1411413

  •  05-07-2019
  •  | 
  •  

Domanda

Ho sempre visto questi commenti di intestazione in php e spesso mi chiedevo se fosse stato usato qualche software per configurarli? Mi sembra di ricordare JavaDoc o qualcosa del genere? Ma non sono sicuro che questo sia generato automaticamente? O è solo un tipo di documentazione standard?

L'esempio seguente è tratto da CodeIgniter : 

/**
 * CodeIgniter
 *
 * An open source application development framework for PHP 4.3.2 or newer
 *
 * @package     CodeIgniter
 * @author      ExpressionEngine Dev Team
 * @copyright   Copyright (c) 2008, EllisLab, Inc.
 * @license     http://codeigniter.com/user_guide/license.html
 * @link        http://codeigniter.com
 * @since       Version 1.0
 * @filesource
 */

Vorrei davvero migliorare il mio commento e penso che sarebbe un'ottima forma per i miei progetti.

È stato utile?

Soluzione

È phpDoc che viene utilizzato da alcuni framework con riflessione per comprendere e utilizzare dinamicamente le classi (dal codice stesso).

Gli IDE lo useranno anche per il completamento automatico, mostrando argomenti di funzione, ecc. Buona cosa sapere se il tuo IDE fornisce quelle funzioni per il Framework che stai usando, ma non il codice che scrivi.

API di riflessione di PHP

Estensione Zend Framework (compresi DocBlocks)

Guida ai commenti di CodeIgniter (utilizzando DocBlock '... in modo che possano essere raccolti da IDE)

DocBlock Descrizione su phpdoc.org ( collegato dalla Guida allo stile di CI)

Altri suggerimenti

Questi commenti seguono lo standard di phpdoc e possono essere utilizzati per generare automaticamente una documentazione per il tuo codice. Puoi vedere un esempio di tale documentazione qui .

Mentre alcuni IDE hanno il supporto per facilitare la loro scrittura, il contenuto effettivo viene scritto a mano dai programmatori.

Alcuni IDE possono inserirlo automaticamente, ma le persone spesso lo digitano.

Per PHP è PHP Documentor , puoi vedere un guida di avvio rapido qui .

Questo eseguirà la scansione del codice sorgente e creerà la documentazione in base ai tuoi commenti su file, classi e funzioni.

Questo è JavaDoc ed è probabilmente generato automaticamente da un IDE.

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top