phpdoc: Sabit bir belgeyi doğrulamanın yolu nedir

Question

define() kullanarak tanımlanmış bir sabiti belgelemek için uygun bir yol var mı? @var gerçekten anlam ifade etmiyor. Düşünebildiğim tek şey etiketi atlamak ve açıklamayı PHPdoc yorumuna yazmak.

Answer 1

phpDocumentor tanımak veya @const etiketi kullanmaz. phpDocumentor, koddaki "define" anahtar sözcüğünü gördüğünde bir sabiti tanır. Çıkış şablonları, sabitler olarak listelenen çıktı belgelerinde tüm sabitleri gösterecektir. Sabitlerin belgesinde ihtiyaç duyulan tek şey bir açıklamadır, ancak diğer "standart" etiketlere ihtiyaç duyduğunuzda izin verirseniz izin verilir [1].

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html#procedural.define

Answer 2

@const'u kullanın.

/** 
    * @const FOO Bar 
    */ 
define('FOO', 'Bar'); 

Documentation (Üzgünüm, bulabilirim Yalnızca doküman Alman içindedir.)

Answer 3

Aslında Github PHP Documentation bkz @type kullanmak istiyorum.