テンプレートのドキュメント

ドキュメントは良いです! これにより、時間を節約し、チームの人々のために調和して仕事をすることができます。 コードに組み込まれたドキュメントは二重に優れており、必要な場所にあり、それを書くために遠くに行く必要はありません。



カットの下に、テンプレートのドキュメントのいくつかの実例があります。







独自のプロジェクトでは、ソースコード(phpDocumentor)に埋め込みドックを記述しますが、

何らかの理由でパターンを無視しますが、とても簡単です!



テンプレートの作成時には、その目的とデータを完全に把握しており、

そこに転送されます。



このようなドックを追加することにより、レイアウト時間と自分の時間を節約できます。



例1 :list.tplテンプレート



{*

投稿リスト



使用者:BlogModule :: listAction

送信された変数:

$ requestedInfo配列の投稿[{id:447、title: 'title'、...} ]

$ pager AE_Pagerページングオブジェクト

$ admin boolean admin / not admin

$年配列[2010,2009,2008]

$ months配列{ 4月: 4 、3月: 3 、2月: 2 }

$ selectedYear年またはnull(「すべて」の場合)

$ selectedMonth monthまたはnull(「すべて」の場合)

*}



{ if $ admin }

<button class = "button" onClick = "window.location = '/ {$ SECTION} / addNews'">エントリの追加</ button>

{ / if }



{ foreach キー = cid item = con from = $ ReturnInfo }

...

{ / foreach }




例2: phpDocumentor表記で:

{*

投稿リスト



この段落の機能とニュアンス、メモ、その他の詳細

@see BlogModule :: listAction

@param array $ returnInfo posts [{id:447、title: 'title'} ]

@param AE_Pager $ページャーページングオブジェクト

@param boolean $ admin admin / not admin

@param array $ years [2010,2009,2008]

@param array $ months { 4月: 4 、3月: 3 、2月: 2 }

@param mixed $ selectedYear年またはnull(「すべて」の場合)

@param mixed $ selectedMonth monthまたはnull(「すべて」の場合)

*}





{ if $ admin }

<button class = "button" onClick = "window.location = '/ addNews'">エントリを追加</ button>

{ / if }



{ foreach キー = cid item = con from = $ ReturnInfo }

...

{ / foreach }




配列を適切に文書化する方法





別の問題があります: phpDocumentorは配列ドックを書き込む形式を言っていません

開発者はしばしばそれを無視します:

    @param array $ returnInfo post array




あまり有益ではありませんか?



私にとっては、ドックでJSON表記の配列の例を挙げると便利だと判断しました。

   @param array $ years [2010,2009,2008]
   @param array $ months {4月:4、3月:3、2月:2}




なぜJSON それは私にとってよりコンパクトで読みやすいからです。



または、PHP構文を提案することもできます。

   @param array $ years array(2010,2009,2008)
   @param array $ months array( 'april' => 4、 'march' => 3、 'february' => 2)




同僚、プロジェクトにテンプレートを文書化していますか?

テンプレートは非常に面倒で複雑になりますか?



All Articles