blog

主にJavaScriptを書いています

flowtypeバッドノウハウ

flowtypeを使ってみて個人的にはまったところ。 v0.65.0時点での話です。仕様なのかバグなのかわからない話も含みます。 enumの罠 flowのenum(正しくはUnion Type)は条件分岐などで、含まれないはずの値と比較しているとエラーを出してくれる。 /* @flow */ …

ドキュメントを書く技術

READMEを始め、ソフトウェアのドキュメント全般を書く技術というものをもっと洗練させていきたい。要件定義書のようなものだけでなく、開発方針や設計方針、API定義などなど。 これらのドキュメントをしっかりと整備するだけで、レビューの質も上がり新しい…

ドキュメントはコードから自動生成させていきたい

ドキュメントは腐りやすい ドキュメントはどうやっても更新されなくなってしまう。Wikiに書こうか、Confluenceのほうがいいのか、色々置き場所を考えてはみるものの、大きく改善することはあまりない。 その理由のひとつが、コードとドキュメントのライフサ…