SDK ドキュメント

SDK は他の開発者に採用される必要があります。貢献者として、決定された SDK がどのように機能するかをあなたより知っている人は誰もいません。ドキュメントを書いて、他の人を助け、SDK の利用を広めてください。

Readme

READMEに次のセクションがあることを確認してください。

  • 必須項目

  • インストール

  • 貢献

  • ライセンス

テンプレート: README

コメントとリファレンス

コードを記述している間に、関数とクラスをコメント付きでドキュメント化します。リファレンスジェネレーターはこれらのコメントを読み取り、HTML として出力を生成できる必要があります。

リファレンスジェネレータの例は Javascript 向けに TypeDoc ですが、Java では Javadoc を使用しています。

選択したプログラミング言語にとって最も便利なリファレンスジェネレーターを調査して決定することをお勧めします。

ガイド

Symbol Developer Documentation は ガイド を集約したものです。これらのガイドは開発者に Symbol ビルドイン機能の使い方を段階的なユースケースを用いて説明します。各ガイドには、ユースケースを解決する実行可能なコード断片のスニペットが一つ以上用意されています。

スニペットの作成は SDK コードが他のコードと対照的にどのように見えるかを比較できます。さらに SDK が正しく動作するかどうかを手動でテストできるでしょう。

  1. https://help.github.com/articles/fork-a-repo をフォークして symbol-docs リポジトリ をクローンしてください。

    git clone https://github.com/<YOUR_USERNAME>/symbol-docs.git

  2. あなたの言語の SDK 用として source/resources/examples/ の下に新しいフォルダを作ってください。

  3. 新しい SDK を使用して、各 TypeScript スニペット に適合する。

  4. 変更をプッシュして プルリクエストを作成 してください。