ブログ「サイバー少年」

ブログ「サイバー少年」へようこそ!
小学六年生ごろからプログラミングを趣味にしている高校生のブログです。
勉強したことについての記事などを書いています。フリーソフトも制作、公開しています。
(当ブログについて詳しくは「ブログ概要紹介」を参照)

サイバー少年が作ったフリーソフトは「サイバー少年の作品展示場」へ

“プラグインをロードする汎用的ライブラリ” アルファ版の公開!

「創る」と言いだして早3ヶ月…。

「プログラムは完成したんでXMLコメントを書いて公開しますよ」と言ったあの日の自分…。


というわけで例のもの、アルファ版は完成です。

いや~、XMLコメントを書く期間がほとんどを食っていました。
というか、長いこと真面目に書いていませんでしたからね。

最近、また真面目にXMLコメントを書く作業を再開しまして、とうとう完成したのです。

意外と苦労しますね。リファレンスを書く作業とは。

プログラムを書くのは楽しさもあるので疲れないのですが、
XMLコメント書いていて「なんだこのつまらん作業は」と思いました。


こんな作業をやり続けたMSDNとSun(大人の事情で現Oracle)の方々には、敬意を持たないといけませんね。

そういえば、MSDNのリファレンスとXMLコメントって違う組織が担当しているのかな…?




さて、“プラグインをロードするライブラリ”の「PluginHostLib」(仮タイトル)の、アルファ版を公開いたしました。

PluginHostLib_0.1.zip - Yahoo!ボックス
http://yahoo.jp/box/rBNIBx


内容は以前の記事にちょこちょこ書いてあります。

もちろん、正式版ではまとまった説明を書くつもりです。


今回は開発段階ということで、「サイバー少年の作品展示場」のリストには載せませんが、正式版が完成したら載せようと思います。


このアルファ版はまだ、ソフトウェアに同梱してリリースしないでください

評価目的での使用のみに限ります。
(リリース時の注意点は正式版で書きます)


また、ソースコードも同梱しています。

ですが、DLLファイルの逆コンパイルや逆アセンブルは禁止です。

よく分からないルールですが、ソースコードは+αだと思ってください。



今後の予定としては、使用法のマニュアルを作ります。

リファレンス的なものではなく、ライブラリ全体の使い方を書いたドキュメントです。

それが完成したら正式版として公開といったところでしょうね。
一応、最初のうちはRC版で出すつもりでいますが。


また、簡単なテストも行います。
テストといっても、使ってみる程度ですが…。

マニュアルにサンプルコードを載せたりするので、
そのコードを書いているときにテストの役割も果たしてくれるでしょう。


また、このアルファ版をダウンロードして使ってくれた方々も、ぜひご協力お願いします。

アルファ版ってテストが面倒だから公開するものですよ(笑)


ダウンロードした皆様、バグを発見したらコメント欄等に報告してくれるとありがたいです。

また、バグ報告以外にも改善点、問題点の指摘もお待ちしております~。


いやぁ、どんなバグが待ち受けるか…。

tag:

コメント

まだ、つかってみてませんが。。。
ドキュメント作成は、
sandcatleを使えば、結構、楽です。
ソースにコメントを書くクセもつけれますし、
一石二鳥です。

http://news.mynavi.jp/articles/2008/07/15/Sandcastle/index.html

おなじみの形式ですね。

  • 2013/08/05(月) 14:46:44 |
  • URL |
  • 通りすがり #EBUSheBA
  • [ 編集 ]

Re: 通りすがり

Sandcastleというツールがあるんですか。
まぁ、VSのオブジェクトブラウザでも似たようなものになりますし、あまりHTML化は必要ないかなと思っています。

今作っているのは、何といえばいいのか自分のボキャブラリには無いのですが、
ドキュメント的なものではなく、実際に作ってみるというマニュアル、解説のようなものです。

Sandcastleでつくった形式は、html化だけではないんです。
ソフトによくある、ヘルプがありますよね。
あの形式にしてくれるんです。

ヘルプファイルなんて、いらない~って言われれば、
それまでのソフトですw

  • 2013/08/05(月) 17:21:29 |
  • URL |
  • 通りすがり #EBUSheBA
  • [ 編集 ]

Re: 通りすがり

…いらないッスね(笑)

基本的にXMLコメントを書けばVSでインテリセンスも出ますし、オブジェクトブラウザーでHTML風に観覧することも可能ですから、HTMLにする必要はないかなと思っています。
まぁ、統合開発環境を使わない人もターゲットにするなら必要かも知れませんけどね。

コメントの投稿

トラックバック

トラックバック URL
http://cyberboy6.blog.fc2.com/tb.php/286-3e32729e
この記事にトラックバックする(FC2ブログユーザー)

当ブログをご利用(閲覧等)になる場合は必ず「当ブログの利用規定」をお守りください。