この CFCDoc Revamped てのは、オリジナルのこのから、いくつか手直しを受けて、CPL で再公開されたものらしい。
確か、以前どこかで見かけて、「ふーん、おもしろそうだなぁ」と思ったきり、忘れていたものじゃないかと思う。
先日、この CFCDoc Revamped を見かけて、ちょっと試してみた。
WEB ルートに CFCDoc を入れて、[[CFCDoc root]]/config/config.xml を編集する。
shopping というディレクトリ内のＣＦＣコンポーネントのドキュメントを見たい場合、
shopping ディレクトリが [[WEB ルート]]/shopping にあるのであれば、
<config>
<root>
<path>../shopping</path>
<prefix>shopping</prefix>
</root>
</config>
としてやると、
http://localhost/[[CFCDoc root]]/ で
のように見ることが出来る
また、デフォルト状態では、日本語が文字化けしてしまう。
そこで、
[[CFCDoc root]]/components/Util.cfc の210行目を
<cffile action="read" file="#file#" variable="fileContents" charset="utf-8">
と、文字セットエンコードを作成しているファイルのエンコードにしてやれば、日本語も正常に表示されるようになる。
では、実際に各種注釈などを表示するためには、どのようにするのか。
画面にある電球マークの部分は、cfcomponent、および、cffunction の hint 属性である。
<cfcomponent name="CartProcess" output="false"
hint="カートの情報を処理するためのロジックコンポーネント">
この hint 属性の注釈は、Methods summary のところに表示される。
また、cfargument の hint 属性を設定すれば、パラメーターの注釈として表示される。
cffunction の属性の中に、description というものがあるが、これは、活かせないのだろうか。
どうやら、CFCDoc では表示されないようである。hint 属性のところにあまり長く書くと、画面が非常に見づらくなるので、description 属性の注釈がどこか違うところで表示できるといいのに。
ということで、こんな感じで納得することにした。
