8

More than 5 years have passed since last update.

@tsukaguitar(Mitsuhiro Otsuka)

ソースコードのヘッダコメントブロック例

Posted at 2013-02-01

ソースコードを書く時、とりあえず埋め込んどくべきかと思ったので
自分用に簡略化して整理。PEARの例を参考にしました。

例

/**
 * Short description for file
 *
 * Long description for file (if any)...
 *
 * PHP versions 4 and 5
 *
 * @category   CategoryName
 * @package    PackageName
 * @author     Hogehoge <hoge@hoge.com>
 * @copyright  2010-2013 Hogehoge
 * @license    http://www.opensource.org/licenses/mit-license.html  MIT License
 * @version    0.1
**/

解説

PHPのバージョンや@category, @packageは必要に応じて。
ライセンスは基本、MITで。ちゃんと全文載せる場合はこちらをコピペで。
その他の項目やライセンスについては、PEARの例を参照のこと。

参考・引用

8

Register as a new user and use Qiita more conveniently

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up

8