アプリなら、コメントが見やすい！
トップへ戻る
掃除・片付け
khondalit.hatenablog.com
仕事しているとドキュメント大事ですよね。 いつ人の移動があるか分からないし、新しく追加されても忙しいと説明する時間もなかったり。 そういう管理しているのが問題なのですがそれはそれとして、やぱっぱりドキュメントはあるに越したことはないです。 ということで、仕様書とかは別にしても現状の成果物に対してのドキュメントの自動化を行っています。 ドキュメントを作りたいけど忙しい方たちはこれを行うだけでも大分楽になるかと。 YARD/RDoc 昔からよくあるソースコードから作るドキュメント。 DoxygenやJavaDocなどのRubyバージョンですね。 適切なコメントを書くと、クラスとそのメソッドのドキュメントを作成してくれます。 Rdocは便利なのですが、YARDの方が一貫性があるなどより良い感じですので、こちらを採用しています。 最悪コメントを書かなくてもとりあえずのドキュメント化はしてくるようで
state_machineという便利なgemがあります。 カラムの状態、状態の別名とかを管理が出来て結構便利に使わせてもらっていたのですが、 もう2年程更新がされておらすRails4.2系だとエラーになる場合もあるようです(確実にエラーになるかまでは分かりません)。 そこでenum 色々調べるとRails4.1から入ったenumを使えばいいかも的な情報を見かけたので使ってみたところちょっと使いづらい。 Rails4 - ActiveRecord::Enum の使いドコロ - Qiita enumの追加の順番が大事なのはCでも同じなので、ある程度熟練したプログラマなら問題にはしません。 今どきC時代と同じ対応が必要なのは微妙な気はしますけど。 問題はi18n。 この対応が出来ない。あくまでも値の別名を付けやすくするだけの機能なのでしょうがないとは思いますがちょっと不親切です。 enum_he
このページを最初にブックマークしてみませんか？
『khondalit.hatenablog.com』の新着エントリーを見る
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
