2010-10-08 18 views
19

phpDoc için sınıf sabitlerini nasıl belgeleyebilirim? Kılavuzu okudum ama onlar hakkında hiçbir şey bulamıyorum.phpDoc sınıf sabitleri belgeleri

+1

'@ var' kullanarak bunu yapmak için doğru yoldur, bkz https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#722-var – m13r

cevap

10

Herhangi bir İngilizce belgesini bulamadığım halde, @const'u kullanabileceğinden kesinlikle eminim. Bir Alman örneği var here. Sınıf sabitleri yerine define ifadelerini gösterir, ancak IIRC sözdizimi aynıdır.

+0

Bilmiyorum neden belgelenmiş değil ama işe yarıyor gibi görünüyor ... – mck89

+6

'@ const' belgelerinin daha iyi bir gözden geçirmesi burada: http://stackoverflow.com/a/18446766/367456 - aynı zamanda böyle bir şeyin mevcut olmadığını da açıklıyor. – hakre

+3

Bu cevaba göre '@ var' kullanılmalıdır: http://stackoverflow.com/a/27772200/2053165 – Leith

29

Sabitler, yalnızca açıklamayı içeren bir belgeye ihtiyaç duyar. Belirli bir etiket gerekli değildir. Kod ayrıştırıcısının kendisi sabitleri tanımlar ve bunları oluşturulan belgelerdeki gibi görüntüler (here's an example).

+2

Bu, [phpDocumentor] (http://phpdoc.org/) için çalışıyor gibi görünüyor, ancak Netbeans’e Otomatik tamamlamada gösterilecek açıklama, diğer cevapta açıklandığı gibi '@ const 'eklemelidir. – feeela

+0

İşte kullandığım şey: http://stackoverflow.com/a/24042505/244826 – Sonny