PHP bilgilendirme kısmı içinde @ Kategori etiket kullanmak nasıl

2 Cevap php

Birisi açıklayabilir veya @ Kategori TAG doğru şekilde kullanmak için nasıl bazı örnekler verebilir misiniz? PHPDocumentator Tag ayrıştırma değil.

Nasıl doğru Dosya bilgilendirme kısmı ve Sınıf-bilgilendirme kısmı gibi görünüyor nedir?

2 Cevap

Ben bu yardımcı olmadığını biliyorum, ama ... Gönderen manual yok:

The @category 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.

/**
 * Page-Level DocBlock
 * @package MyPackage
 * @category mycategory
 */

/**
 * @global array used for stuff
 */
function mine()
{
    global $baz;
    ...
}

Ayrıca, burada @ kategori ile bilgilendirme kısmı da dahil olmak üzere, bir sample of the proper way to write PEAR code bulunuyor.

Ayrıştırma değil bazı örnek kod sonrası Lütfen - neyin yanlış cevap yardımcı olabilir.

Ben @ kategori etiketini kullanma konusunda herhangi bir yararlı örnekler bulmak mümkün olmamıştır. O etiketi IE kullanarak MVC katmanları temsil etmek için kullanmak bana mantıklı:

/**
 * Layout or template
 * 
 * @category view
 */

/**
 * Database representation of the user
 * 
 * @category model
 */

/**
 * Login actions
 * 
 * @category controller
 */

İşte bunu kullanmak nasıl.