2010-02-03 22 views
11

PHP'de define() ile tanımlanan (phpDocumentor ile) sabitleri nasıl belgelemeliyiz? PHP sabitleri (define) phpDocumentor ile belgelemek için doğru yol nedir?

Docs içinde hiçbir şey bulunamadı, ancak aşağıdaki örnek buldum sample2.php (I görmüyorum hangi yaramaz):

/**#@+ 
* Constants 
*/ 
/** 
* first constant 
*/ 
define('testing', 6); 
/** 
* second constant 
*/ 
define('anotherconstant', strlen('hello')); 

Herkes sabitlerini belgelemek için en iyi yolu nedir bana söyleyebilir phpDocumentor ile PHP'de?

cevap

6

Tanımlama ifadeleri genel olarak yalnızca açıklayıcı bir metinle yorumlanır, yani temel olarak nasıl yorumladığınız vardır.

DocBlock şablon etiketi hakkında daha fazla bilgi için, /**#@+, the manual page'a bakın.

+0

o şöyle Constant bak bu deneyin. Örneğinizin üst kısmında görünen "şablon etiketi", yalnızca * "Sabitler" tanımlamanızın her bir tanımınıza ("ilk sabit", "ikinci sabit") eklediği bir kısayol olarak bulunur. Bu şablon etiketinin kullanımı, yalnızca ortak metinleri birden çok farklı açıklamaya koymak istiyorsanız gereklidir. – ashnazg

+0

Tüm bağlantılar kullanılamaz – Loenix

0

phpDoc.org the elements that can be documented adresinde bulundunuz mu?

Ayrıca an example of documenting a define() (ikinci kod parçası ve çevresindeki paragraflar) var.

+2

Bu örnek aslında foo() işleviyle yanlış bir şekilde ayarlanmış "define" deyimine sahip olmanın ve işlevlerin docbllock öğesinin, belgenin işlev yerine tanımlanmış sabitle yanlış ilişkilendirilmesine neden olacağını göstermeye çalışmaktadır. Sabit bir belgeyi göstermek için öğreticide yararlı bir örnek görmüyorum, bu yüzden phpDocumentor'un dosyalarından birinde bir tane buldum ... sayfanın altına bakın (http://manual.phpdoc.org/ HTMLSmartyConverter/eller/__ filesource/fsource_phpDocumentor_Parsers_phpDocumentorConvertersXMLDocBookpeardoc2Tokenizer.php.html). – ashnazg

+1

Tüm bağlantılar kullanılamaz – Loenix

+0

Proje dokümantasyonun yerini değiştirdi. Yeni konum: https://phpdoc.org/docs/latest (Üzgünüm, Gönderdiğim bölümleri bulamıyorum) – xOneca

1
/** 
*@const 
*/ 
const testing=6; 
const anotherconstant=strlen('hello'); 

Özel bir etiket gereklidir Eğer

İlgili konular