Uygun PHP fonksiyon dokümantasyon biçimi nedir?

4 Cevap php

PHP belgelerine bile underscore_vsCamelCase styling bu çeşitli değil, bir vahşi hayvan. Yani PHP belgelerin her türlü verilen şimdiye kadar gördüğüm - standart hangisi? IDE ve dokümantasyon kütüphanelerinin çoğunluğunun onları okuyabilir böylece nasıl fonksiyonları ve yöntemleri kadar belirgin olması gerekiyordu?

Aşağıdaki örneklerde, (tip) birisidir:

  • bool
  • int
  • dizi
  • nesne
  • dizi
  • şamandıra

ve isim ($ değerler gibi) param değişkenin sadece 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))

4 Cevap

Hiçbir resmi according to Hoyle, yorum tarzı vardır. Bulacaksınız yakın Zend Framework coding guidelines. Zend Framework PHP oluşturulması derinden dahil olan Zend, tarafından üretilen, bu nedenle onların kodlama kurallara uyulmalıdır olanlar olduğunu söyleyebiliriz.

Ayrıca ileri sürülebilir ki şeklini alır herhangi bir açıklama

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

Bu yansıma API ile ayrıştırılır ve hazır olacak gibi bir "resmi" belge biçimi. Birçok kişi bu kaldıraç, ve PHPDoc biçiminde bir resmi-imsi açıklama biçimi üretmek.

Birçok kişi standart olarak PHPdoc kullanın.

I PHPDoc hemen hemen standart olduğunu düşünüyorum. Ayrıca soru asked before (belki biraz daha fazla fikir verir) idi.

Bu doxygen bir göz alarak değer olabilir. Bu çoklu dil desteği ve standart girdi biçimi vardır.

etiketler