鍵となる考え方：コメントは領域に対する情報の比率が高くなければいけない コメントを簡潔にしておく シンプルに説明できることをダラダラ書かない。 // int は CategoryType。 // pair の最初の …
カテゴリーアーカイブ: 読書メモ
『リーダブルコード』第5章 コメントすべきことを知る
コメントの目的は、書き手の意図を読み手に知らせることである。 コメントするべきではないこと コードからすぐにわかることをコメントに書かない ひどい名前はコメントをつけずに名前を変える 自分の考えを記録する 「監 …
『リーダブルコード』第4章 美しさ
コードの美しさの3つの原則 読み手が慣れているパターンと一貫性のあるレイアウトを使う。 似ているコードは似ているように見せる。 関連するコードをまとめてブロックにする。 なぜ美しさが大切なのか？ プログラミ …
『Web API デザインの鉄則』第4章 エラー表現とドキュメント
第1章 第2章 第3章 Web APIのドキュメントに明示する必要がある項目としては、次のような事柄が挙げられます。 認可(Authorization)の方法、必要な権限(scope) エンドポイントURLやHTTPメソ …
『Web API デザインの鉄則』第3章 インタフェース設計
第1章 第2章 Web APIのインタフェースを定義する際に決めなければならない点は以下になります。 エンドポイントURI HTTPメソッド クエリパラメータ エンドポイントURIの定義 ROA(Resource Ori …