ファイル上部に@package WordPressとつける意味

  • masamasa_japan

    (@masamasa_japan)


    11年、 3ヶ月前

    <?php get_header(); ?>

    ↑私はこう書きました。

    <?php
/**
 * TOPページ
 *
 * @package WordPress
 */
get_header(); ?>

    ↑しかし、先輩はこう書きました。

    質問
    １、何故こう書いたのでしょうか？
    ２、@package WordPressは何か意味があるんでしょうか？
    ３、先輩の様に書いた方がいいのでしょうか？

3件の返信を表示中 - 1 - 3件目 (全3件中)
  • nobita

    (@nobita)

    11年、 3ヶ月前

    phpDocumentorなどで、ファイルの図書を作る時のためですが、

    http://www.hazymoon.jp/php/phpDocumentor/

    必ずしも、documentor向けの書き方とはいえないところもあったと思います

    * @package WordPress

    は、ワードプレスのコアファイルではないので、使ってはいけない。と公式テーマを審査するテーマレビュアーから指摘され、修正した事があります

    テーマなら、

    * @package theme name

    といった形で、記述するのが普通のようです

    nobita

    (@nobita)

    11年、 3ヶ月前

    重複

    shirakobato

    (@shirakobato)

    11年、 3ヶ月前

    重複していたため、こちらに回答を引っ越しました。

    正しい回答は先輩がお持ちだと思います。

    あくまで推測ですが、質問1/3の回答です。どれが正解かは先輩が回答してくれるでしょう。
    1. PHPソースに対するコーディング規約があるから
    　→ コーディング規約がある場合、先輩の様に描く必要があります。
    2. PHPソース管理を行う必要上、何をするソースであるかコメントをつけたため
    　→ ソース管理を行っている場合は、先輩の様に描く必要があります。
    　　　行っていない場合でも、誤って関係ないソースを変更しないように「書いた方がいい」と思います。
    3. phpDocumentor等のツールを用いてドキュメントを作成するため
    　→　納品物にドキュメントがある場合、先輩の様に描くことで工数がいくらか削減できます。
    4. ソース作成のお作法だから
    　他の言語でもお作法はあります。
    　しかし、必ず従わなくてはいけないものでもありません。
    　メリット・デメリットを理解した上で取り入れた方がいいものは取り入れましょう。　

    質問2の回答です。
    ソース構造のカテゴライズ等に使用する慣用句です。
    先輩の例ではWordPress用のPHPソースであることがわかります。
    参考までに、phpDocumentorのヘルプを紹介します。
    http://www.phpdoc.org/docs/latest/for-users/tags/package.html#

3件の返信を表示中 - 1 - 3件目 (全3件中)
  • トピック「ファイル上部に@package WordPressとつける意味」には新たに返信することはできません。

タグ