1. 無料アクセス解析

スポンサーサイト 

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

オカメインコさんの嘴の上に乗ったタネ 

プログラムの質は気配りによる

今日は、名鏡恵さんところからタネを拾ってきました。ご紹介する記事のキモは、名鏡恵さんご自身が書いておられるように、プログラムのはどこまで配慮できるかによって決定するというところなのですが、ベータテスタの私は、その上の部分を拾います(引用冒頭の()内はしゅが)。

プラグインを)組み込む場合の注意点のコメントプラグインの使用者には必要なものです。ですが、表示されるHTMLには必要なものではありません。HTML上には最低限のコメントがあればよいはずです。

長大なコメントはレンダリングには一切影響を与えませんが、HTML上に存在すればそれだけ読み込みを遅くします。それはほとんどの環境で無視できるレベルかもしれません、が、それを『無視できる』と決め付けることはできません。アクセスのたびに無駄なデータを返しているという事実は変わりません。

また、カスタマイズ方法などのコメントは、その読み手がFC2のプラグインのシステムを理解していない場合、読み手を混乱させる要因となりえます。 つまり『コメントはなくてはならないが、HTMLまでもって行くべきコメントとそうでないコメントがある』わけです。

ということで、こういう場合は、プラグイン内でコメントを not_plugin ブロック変数(プラグインが無効な場合のみ有効になるブロック)で括ることが有効だ、と書いておられます。

つまり、

<!--plugin-->
  [プラグイン内に表示したいHTML]
 <!--not_plugin-->
  [HTMLに出力させる必要のないコメント]
 <!--/not_plugin-->
<!--/plugin-->

こんな風に書くと、人にもCPUにも比較的易しく優しいソースになるであろう、ということです。

<!--plugin-->〜<!--/plugin-->の中に、<!--not_plugin-->〜<!--/not_plugin-->を書き込むとは思いも寄りませんでした。この2つは同等と思っていたため、そういう発想に至らなかったのです。頭堅いですね。

ただ、これだと、ソースがまたまたややこしいことになります。ソースを見るのに慣れているユーザならいざ知らず、そうでないユーザだと入れ子で頭がごっちゃになりそうです(ごっちゃになる場合は、すこんぶのようなツールがあることはありますが)。

<!--not_plugin-->〜<!--/not_plugin-->の流用でなく、コメント用のブロックがあるといいなと思いますが、どうなんでしょうね?を設けていただけたらな、と思います。

もちろん、不必要に長い説明文は、別途ドキュメントとしていただくとして(共有テンプレート魅力倍増化計画)、ソース内に是非置きたい、でもHTMLとして出力するのはどうかというものや、HTML内でもコメントとして残しておきたいもの、と、名鏡恵さんの案のようにしていただけると非常に嬉しいです。

これと話は少し違いますが、「何をHTMLとして出力するか」という話において、管理画面のプラグインの上下の説明が空欄の場合は、<%plugin_first(second,third)_description(description2)>周りのソースを出力させなくするブロックなどあったら嬉しいなと思います。が、そこまで気にする輩は、テンプレートを編集すれば事済むことか。サーバの負荷とどっちが、という話になるものやら。

あわせて読んでね

スポンサーサイト

コメント

コメントの投稿















管理者にだけ表示を許可する

トラックバック

この記事のトラックバックURL
http://sweetspots.blog1.fc2.com/tb.php/125-6ec499a4

コメント機構は必須

sugerさんのFC2ブログ新システムのβテストブログSweetSpotで、このエントリで出した例が出ていたので、コメントしようかと思ったのですけど、長くなってしまったのでトラックバック。コメント用のブロックがあるといい

  • [2007/07/17 18:01]
  • URL |
  • それは仕様? |
  • TOP ▲
上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。