phpDocumentor @param gibi ve file-level bilgilendirme kısmı içinde @return etiketleri olmaz ...
Eğer gibi Mr-sk 's cevap başına, onları belgelemek için, ayrı bir dosya seçerseniz, orada işaret @link kullanabilirsiniz, ancak bu dosyanın belgelerinde hemen görünür olmayacaktır sayfa ... sadece size bilgi görmek gitmek için tıklayın gerekecek bir köprü olacak. Eğer bu dosyanın içeriğinin herhangi bir script dosyası için dokümantasyon sayfada görünür olmasını istiyorsanız, {@example} etiketi buna işaret etmek için, ya da hatta sadece bazı çizgiler, örneğin inline kullanabilirsiniz {@example /path/to/file 3 5} sadece hatları ile beş üç göstermek için.
Bu senaryoda, muhtemelen phpDocumentor zaten kod unsurları olarak onları tanımak nerede için parametreleri etiketleme aslında doğrudan bir yolu var değil çünkü sadece, dosya düzeyinde bilgilendirme kısmı uzun açıklamasında şeyleri açıklamak için tercih ediyorum. Benim açıklamalarında kullanılan parametrelerden herhangi gerçekten başka bir yerde kod kaynaklı kod elemanları belgelenmiş olsaydı, ben bu kod elemana işaret inline {@link} etiketi kullanmak istiyorum.
Örneğin, başka bir kod dosyasında tanımlanan bazı sabitler var diyelim, ve bu diğer dosya ayrıştırıldı zaman o elemanlarının kendi belgelerine oluşturulan alır. Ben (sizinki gibi) bir komut dosyayı sadece dosya düzeyinde bilgilendirme kısmı yazmak benim uzun açıklama parametre olarak bu sabitleri bahsediyor, o zaman benim cümle olabilir:
If $POST['foo'] is set, its value should always be either {@link BAR_CONST} or {@link BAZ_CONST}.
Referanslar:
