Coding - nekomaru0510/Violet GitHub Wiki

コーディング

ルール

  • コーディング規約を守る
  • ドキュメンテーションコメントを記載する
  • 公開関数に対してユニットテストを記載する

コーディング規約

rust fmtと同様

ドキュメンテーションコメント

rust docによって各モジュールや関数の仕様を把握できるようにする。

詳細は下記参照

Documentation

テスト

cargo testによってviolet本体(ライブラリ)のテストを可能とする。

(シェルスクリプト等でシステムテストもしたい)

詳細は下記参照

Test