Genel olarak, PHPDoc özellikleri kendi kendini açıklayıcı, ama bu anlayış zor anlar yaşıyorum:
@category
- bu tam olarak nedir?
@package
- Bazı biri bana bu özelliğin kullanımı ile ilgili örnekler verebilir misiniz?
Paket etiketi kodunuzda kullandığınız anahtar organize etikettir. PhpDocumentor dokümanlar oluşturduğunda, bu set paketleri içine öğeleri toplar. Bazı durumlarda, sadece tüm kod temeli için bir paket adı (@ paket MyPackage) kullanmayı seçebilirsiniz vb tüm dosyalar, sınıflar, bu paketin docs görünecektir böyle.
Daha modüler şeyleri organize seçerseniz Ancak, tek bir pakette tüm web bakan usul dosya olabilir (@ paket sayfalarının), bir paket içinde tüm veritabanı bakan sınıfları (@ paket DatabaseHandlers), bir paket bütün yardımcı sınıfları ( @ paket Utilites), ve ve üzerinde.
@ Paketi hakkında hatırlanması gereken önemli şey organizing the docs ... o kodu nasıl çalıştırdığını ile ilgisi için bu cadde olmasıdır. Şimdi, belli ki bunu {[gibi, bu anlamda, "paket" would hissediyorum böylece kavramsal, Kafanın içinde app parçaları düzenlemek nasıl dayalı dokümanlar düzenlemek istediğiniz daha olasıdır (2)]} ... em> Ama sonunda, paket etiketi tüm phpDocumentor dokümanları düzenlemek istiyorum nasıl üzeredir.
Kategori etiketi gelince, ben herhangi bir çıkış dönüştürücüler biri (ler) dışında PEAR projeye önemli o kullanan inanmıyorum. Kategori büyük bir paket halinde paketlerin setleri toplamak için kullanılır. Fakat yine de, bu kadar yetenekleri zaten çıkış dönüştürücüler içine pişmiş ne gibi, ARMUT sadece alakalı. Eğer phpDocumentor dokümanlar nasıl organize çekirdek çünkü ... sen cannot, paket etiketi görmezden istiyorsanız can bu etiketi görmezden.
Seengee Daha önce de belirtildiği gibi Şimdi, @ paketi kullanarak örnek olarak, bazı kılavuzunda bulunmaktadır. Uzun lafın kısası, bir paketin her dosyanın dosya düzeyinde bilgilendirme kısmı in etiketini (global-scoped fonksiyonları ve sabitler onların "paket" alacağı bu nerede), ve her sınıfın bilgilendirme kısmı ihtiyaç. Bu kod elemanları için paket değerleri vermezseniz, phpDocumentor sadece bir "default" paketine içine hepsini dökümü zorunda kalır.
Çeşitli paketler halinde kodunuzu organize umurumda değil, ve @ paket etiketleri eklemek için tüm dosyalarınızı düzenlemek istemiyorsanız Son nokta ..., yerine varsayılan bir paket ayarlamak için-dn zamanı argümanını kullanabilirsiniz adı [1]. Bu bir paket adı istediği tüm "paketlenmemiş" kod elemanları için bu argüman verdiğiniz paket adını kullanmak phpDocumentor söyler. Orada varsayılan bir kategori adını ayarlamak için bir-DC argüman da, ancak bu kadar phpDocumentor söz konusu olduğunda çok daha kritik bir ihtiyaç.
(... More URL'ler dahil edildi, ama bana daha bir tane göndermek stackoverflow izin vermez)
@ Kategori
The @ Kategori tag is used to organize groups of packages together.
This is directly applicable to the XML:DocBook/peardoc2 Converter, and can be used by other converters. Other Converters packaged with phpDocumentor ignore the category, but this may change in future versions. It is also possible to dynamically specify category using the -dc, --defaultcategoryname command-line switch
http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.category.pkg.html
@ Paketi
@ Paketi can only be used to document procedural pages or classes.
Packages are used to help you logically group related elements. You write classes to group related functions and data together, and phpDocumentor represents the contents of files (functions, defines, and includes) as "Procedural Pages." A package is used to group classes and procedural pages together in the same manner that a directory groups related files together.
http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.package.pkg.html