SORU
14 Aralık 2009, PAZARTESİ


Uygun PHP belgelerine biçim işlevi nedir?

PHP belgelerine bir vahşi hayvan, underscore_vsCamelCase stil bu zengin bile değil. PHP belgelerine her türlü verilen şimdiye kadar gördüğüm kapsayan bir standarttır? Nasıl fonksiyonları ve yöntemlerimi IDE ve belge kitaplıkları çoğunluğu onları okuyabilir böylece işaretlenmiş olması gerekiyor?

Aşağıdaki örnekler (tür):

  • bool
  • int
  • dizi
  • nesne
  • string
  • yüzer

ve Adı sadece param değişken ($değerler) adıdır

/*
 * Function name
 *
 * what the function does
 *
 * @param (type) about this param
 * @return (type)
 */
function example((name))

/*
 * What the function does
 *
 * @param (name) about this param
 * @return (name)
 */
function example((name))

/**
 * Function name
 *
 * what the function does
 *
 * @param (type) (name) about this param
 * @return (type) (name)
 */
function example((name))

/**
 * Function name
 * what the function does
 *
 * Parameters:
 *     (name) - about this param
 */
function example((name))

CEVAP
14 Aralık 2009, PAZARTESİ


Resmi, according to Hoyle, yorum tarzı yok. Bulabileceğin en yakını Çerçeve coding guidelines ... ... Çalışabilir. Çalışabilir Çerçeve derinden PHP oluşturulması dahil olan Çalışabilir, tarafından üretilen, kodlama yönergeleri takip edilecek olanlar söyleyebiliriz.

Ayrıca herhangi bir yorum halini alır söylenebilir

/** <--- starts with
*/  <--- ends with

"Bu işlenecek ve yansıma API üzerinden yaptı." belgelerine biçimi, resmi. Birçok kişi bu kaldıraç ve PHPDoc biçimi resmi gibi yorum biçimi üretmek için.

Bunu Paylaş:
  • Google+
  • E-Posta
Etiketler:

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • BruBearBaby

    BruBearBaby

    25 Ocak 2011
  • Jeremy Gallman

    Jeremy Gallm

    11 NİSAN 2012
  • LinusTechTips

    LinusTechTip

    25 Kasım 2008