Nasıl PHP fonksiyonları ve sınıfları inline belge mi?

6 Cevap php

PHP kodu inline belgeler için birçok farklı standartlar vardır biliyorum. İşte satır içi belgelerine göre ne demek, ve daha iyi bir terim varsa beni düzeltin lütfen:

/**
* This is the description for the class below.
*
* @package    my-package
* @subpackage my-subpackage
* @author     my-name
* @version    my-version
* ...
*/
class orderActions {
...

Inline belgelerin en iyi ve en yaygın kabul gören biçimi nedir? Bu tür belgeleri otomatik oluşturmak için herhangi bir alet var mı, ya da elle yapılması gerekiyor?

Ben kılavuzları üreten ilgilenmiyorum - Ben yukarıdaki kod yorumlama, ya da türünü oluşturmak için nasıl bilmek istiyorum "inline belgeleri."

6 Cevap

PHPDoc, gönderdiniz, ne gibi PHP belgelerin yaygın olarak kabul edilen şeklidir.

Sen Doxygen dokümanlar otomatik oluşturmak için kullanabilirsiniz.

Düzenleme: kodunda in-line dokümantasyon üretme açısından, ben geri gitmek ve bir proje için dışarıdan bu yapacak bir araç rastlamak hiç. Genellikle bir şablon size kod ederken oluşturmak için IDE alanda bıraktı.

Eclipse aslında bu iyi bir iş yok (o Eclipse hakkında Sevdiğim birkaç şeylerden biri) ve ben Netbeans de yok inanıyorum. Herhangi bir büyük IDE muhtemel şablon nesil bu tip yardımcı özelliğe sahip olacak.

Ben bazı IDE senin için bir şablon oluşturabilir varsayalım rağmen Genellikle, bilgilendirme kısmı kendini comments yazardı.

Ben aslında yaptım write a program, which can trace a running program and detect parameter types and write them back as docblock comments. Bu biraz adamcağız, ama bu tür işleri.

Ben tam olarak kullanılan olmasına rağmen, Doxygen bu görev için umut verici görünüyor.

Java için Javadoc aracı ile aşina iseniz, bu oldukça benzer. Sen Doxygen stili kullanmak ve daha sonra belgeler üretmek için kaynak dosyalar üzerinde aracını çalıştırın.

Değil emin ne de kod ama ben yerine güvenen ayrıntıları doldurarak yaşıyorum beri bu iyi sonuçları ile biter buldum çeşitli parçacıkları (I Textmate kullanabilirsiniz) ben çalışıyorum ben sadece eklemek değil) var Benim için bunu yapmak için sistem.

Bu başlangıçta çok iş ama uzun vadede buna değer gibi görünüyor

i kullanımı çok basit ve phpdoc ile uyumlu bir documentator yarattı:

Örnek:

<?php
    $docs = new QuickDocumenter();
    $docs->parseString("
    /**
    *   Sanitize string
    *
    *   @sinse      1.0
    *   @version    1.0
    */
    ");
    foreach( $docs->result() as $doc)
    {
        highlight_string( print_r( $doc , true ) );
        echo "<hr/>";
    }
?>

Github Bkz:

https://github.com/olaferlandsen/QuickDocumenter

Bye!

Belgeler? Bu nedir?

Ben sadece açık kod yazmaya çalışın.

etiketler