Home - y-d-yamashita/docs GitHub Wiki

CellML-Compilerドキュメント

ドキュメント規約

  1. ドキュメントを書く場合は、default.mkdをコピーする(拡張子は.md)
  2. タイトルと同じ名前(#と等価)で保存する(タイトルに英語を使う場合、複数形は使用しない)
  3. default.mkdの項目を埋めた後に内容を書く
  4. マークダウン記法で記述
  • date 日付
  • last_update 日付 (更新したらしっかりと更新すること、初めて作ったなら書かなくておk)
  • author 書いた人 (誰かが追記したら追加すること)
  • tag 言語名や、フレームワーク名など
  • subtag さらに小分けしたカテゴリー。例えば、[プラグイン] [コード規約] など