PHP Yorum formatı: auto oluşturulan veya Kullanıcı yarattı?

4 Cevap php

Ben her zaman php bu başlık yorum görülür ve bazı yazılım onları kurmak için kullanılan genellikle eğer merak ettik? Ben Javadoc falan hatırlamak gibi görünüyor? Ama bu otomatik oluşturulur emin değilim? Ya da bu belge standardın sadece bazı türüdür?

Aşağıdaki örnek ikinci bir CodeIgniter,

/**
 * CodeIgniter
 *
 * An open source application development framework for PHP 4.3.2 or newer
 *
 * @package 	CodeIgniter
 * @author  	ExpressionEngine Dev Team
 * @copyright   Copyright (c) 2008, EllisLab, Inc.
 * @license 	http://codeigniter.com/user_guide/license.html
 * @link    	http://codeigniter.com
 * @since   	Version 1.0
 * @filesource
 */

Gerçekten benim yorumlama geliştirmek istiyorum ve bu benim projeleri için büyük bir formu olacağını hissediyorum.

4 Cevap

Bu dinamik anlamak ve kullanım sınıfları (kodunun kendisi) için yansıması ile bazı çerçeveler tarafından kullanılan phpDoc hangi bulunuyor.

IDE de IDE senin kullanarak Framework için bu fonksiyonu sağlar bilmek fonksiyon argümanları, vb İyi bir şey gösteren, otomatik tamamlama için kullanabilirsiniz, ancak kod yazmak değil.

PHP's Reflection API

Zend Framework Extension (including DocBlocks)

CodeIgniter's Comment Guide (Using DocBlock '...so they can be picked up by IDEs')

DocBlock Description on phpdoc.org (linked from CI's Style Guide)

Bazı IDE otomatik olarak koyabilirsiniz, ama insanlar genellikle sadece içeri girin

PHP için PHP Documentor, bir quickstart guide here görebiliyorum.

Bu kaynak kodu tarar ve dosyaları, sınıflar ve fonksiyonlar için yorumlarına dayanarak belgeleri yaratacaktır.

Bu yorumlar phpdoc standardını takip ve otomatik kod için bir dokümantasyon oluşturmak için kullanılabilir. Sen böyle bir belgelerin bir örneğini görebilirsiniz here.

Bazı IDE kolay bunları yazma yapmak için desteğe sahip olurken, gerçek içerik programcılar tarafından yazılmış olduğunu.

Bu Javadoc ve muhtemelen bir IDE ile autogenerated oluyor.

etiketler