Ben geçmişte de adil bir kaç php uygulamalar yazdık, ama bu gece bu yüzden ben de düzgün benim kod belge düşündüm SVN'de içine benim ilk baskını olduğunu. Php fonksiyonlarını belgelenmesi için benimsenen biçimi nedir?
Tüm iyi o zaman dokümantasyon araçları tarafından kullanılabilecek bir varsa, Açıkçası ben kendi biçimini benimsemek olabilir, ancak, ileriye dönük.
Şerefe!
http://www.phpdoc.org/ Ben bir süre için tüm satır içi dokümanlar için bu stili kullanmaya çalışıyorum, ve yardım için birkaç diğer araçları vardır.
Son olarak, ben her gece bir cron işi aşağıdaki kabuk komut dosyasını çalıştırın:
#!/bin/sh DIR=`readlink -f $0` DIR=`dirname $DIR` DIR=`readlink -f $DIR/..` # ignoring the (/blog, ) root dir, *.sh files or backups # find files changed in the last day FIND=`find $DIR/ -mtime 0 ! -name '*\.sh' ! -iname '\.bak' ! \ -iname '*~' -type f ! -name \.svn \ | grep -v \.svn | grep -v "/blog/" | grep -v '/tmp/' ` test -n '$FIND' && clear;echo "The following files have changed: \n$FIND\n" # if there are no files, exit. test -z "$FIND" && exit # OK, there may be something new to document # and the PHPdocs phpdoc -c phpdoc.ini $@
ve phpdoc.ini olduğunu:
[Parse Data] title = WEBSITE-NAME Manual hidden = false parseprivate = on javadocdesc = off defaultcategoryname = Documentation defaultpackagename = WEBSITE quiet = on target = /web/Hosts/docs/phpdoc readmeinstallchangelog = README, INSTALL, FAQ, LICENSE directory=../php,../includes ignore=.svn/,tmp/ output=HTML:Smarty:PHP sourcecode = on
(Örneğin dayanarak web sitesinde phpdoc.ini
Ben bir standart farkında değilim, ama otomatik belgeler için phpDocumentor kullanabilirsiniz.
PHP belgelenmesi için kimse sağlam bir standart yoktur. Eğer bir CMS veya Framework ile çalışıyorsanız herhangi bir özel dokümantasyon yöntemleri için kendi belgelerini kontrol edin.
Bir proje için bir öneri arıyorsanız, ben Açık Kaynak gördüğüm en yaygın yöntem kullanmak için PHPDoc.
