ソースコードのドキュメント

4 件のメッセージ サトシ・ナカモト 2010年7月16日 — 2010年7月18日

外部APIのライブラリではそれが好きだが、コードから察せるように、内部関数に対しては好みではない。各関数の大きな義務的コメントヘッダーはコードを間延びさせ、コメントヘッダーが関数より大きくなるような小さな関数の作成をためらわせる。メンテナンスの手間もかかり、関数の変更にはコメントヘッダーの重複した変更が必要になる。コードをコンパクトに保ち、画面上でより多くのコードを一度に見られるようにしたいのだ。

今の段階でそれらを追加しても、関数を見れば明らかなことしか書かれないだろう。

外部APIはrpc.cppにあり、使用方法のドキュメントはヘルプ文字列に記載されている。

せっかくの提案に水を差してすまない。

init.cppにある。

wxWidgetsアプリなので、main()関数はない。もうすぐあるかもしれない。bitcoindをwxBaseなしでビルドできるようにするのがかなり近いところまで来ている。(init.cppに入る予定だ)

ファイル名を「main.cpp」にしてしまい申し訳ない。別の選択肢としては「core.cpp」がありえた。今さら変更するには遅すぎる。個人的にはまだmain.cppが好みだ。

JSON-RPC関数の推奨使用方法を示すサンプルコード、例えば典型的なオンラインショップのウェブサイトにおける基本的なアカウントシステムの実装が非常に必要だ。ユーザー名をラベルとして使用するgetreceivedbylabel、そのアカウントに保存されたアドレスが使用済みになったら新しいビットコインアドレスに変更する方法などだ。以前フォーラムでサンプルコードの断片を投稿した。(getreceivedbylabalまたはgetnewaddressで検索してほしい)サンプルコードは、入金と支払い送信ができるプレーンなバニラ銀行サイトにできるだろう。

意図的にドキュメント化していないすべてのコマンドをドキュメント化するつもりだとは思わなかった。それらはサポート対象外であり、ユーザーが使用することを想定していない。

ユーザー向けのすべてのコマンドは -? ヘルプに一覧表示されている。

それらはソースコードを読む勇敢なプログラマーだけを対象としている。