リーダブルテストコード - Qiita
はじめに よく言われるように、ソースコードというものは書かれることよりも読まれることの方が多く、それゆえ読みやすいコードを書くということが非常に重要です。それはテストコードにおいても同様であり、プロダクトコードと同等に資産として扱う必要があります。 テストコードは具体的な値を用いて記述し、また複数の変数の値の組み合わせでテストケースを起こすため、プロダクトコードと比べて冗長になりがちです。 書籍『リーダブルコード』の14章でもテストコードの読みやすさについて触れられていますが、本稿では読みづらいテストコードをリファクタリングして読みやすくするためのテクニックを紹介したいと思います。 なおサンプルコードはJavaScriptで記述されており、そのテストコードはJest1を用いて書いています。 ソースコードはGitHubにあります。 リファクタリング(その壱) 以下の、決して読みやすいとはいえ
可読性と変更容易性のため、気をつけていること - Qiita
コメント頂いた件について追記しました。 2020/02/24 22:17 パイプライン演算子について追記しました。 2020/02/26 1:59 コメントの返信は終了しました。 2020/02/26 11:46 タイトルを変更しました。旧タイトル「可読性のためなら改行してくれ」 2020/02/27 09:38 この記事の内容は可読性と変更容易性の向上のための 1つの方法を記載しています。 可読性の感じ方には個人差があります。 ソースコードで一番大事なのは、 速度よりも可読性 です。 少しくらい速度が上がるからといって、可読性を損なうのは基本的には避けるべきで、 止む得ない事情がある時のみであると、自分は思ってます。 ・可読性を損なわない高速化は行う ・可読性を損なう高速化の場合は正しいクラス設計で開発し、動きが保証されてから最適化する 例 特定の文字列をもらった後に、決まった文字列を後
リーダブルコード 5-6章 コメントについて · GitHub
readable-code-chap5-6.md 5章 コメントすべきことを知る コメントの目的は書き手の意図を読み手に知らせることである コメントすべきでないことを知る コードを書いているときの自分の考えを記録する 読み手の立場になって何が必要かを考える コメントすべきではないこと パっとみて当たり前にわかることをコメントに書かない // 休日を計算する function caliculateHoliday() { ... } // 関数実行時の年の1/1から12/31まで、祝日を除く休日を計算する function caliculateHoliday() {....} コメントにパッと見でわからないことを書くようにしよう 関数名がひどい場合はコメントではなく関数名を書く // Kintoneのカスタマイズでコメントを128kbに制限する // コメントにはコメント内容、コメント時刻、コ
PHPのテストで本当にdataProviderを使う必要があるのだろうか - ぼっち勉強会
PHPUnitにはdataProviderという機能がある。 パラメタライズドテスト、またはテーブルドリブン(駆動)テストで書くための仕組み。 僕はずっとこの機能が使いづらくて、普通にforeachで回す方が良いのではと思っている。 今日たまたまdataProviderを推奨している記事を続けて目にしたので、改めて考えを整理しておく。 dataProviderのメリット foreachと比較したdataProviderのメリットはこちらの記事が分かりやすかったので引用する。 PHPUnitとデータプロバイダとテストケース生成 メリット1: setUp/tearDownが使える 確かにモックを使うテストならその方が助かる。 メリット2: どのデータでテストが落ちたのか分かりやすい 確かにforeachだとちょっと面倒。Goでテストを書いている時にt.Error()をいちいち書いていく感覚に似
Kentaro Haraさんのツイート: "Googleの2億行のソースコードを解析した結果、関数に渡す引数の順番を間違える系のバグは、引数の個数が6個以上になったときに著しく増えるので、引数の個数は5個以下が望ましいことがわかったという話。 https://t.co/R5yy31pDyu"
Googleの2億行のソースコードを解析した結果、関数に渡す引数の順番を間違える系のバグは、引数の個数が6個以上になったときに著しく増えるので、引数の個数は5個以下が望ましいことがわかったという話。 https://t.co/R5yy31pDyu
if elseのコメントの書き方 - アーキテクチャをスマートに。
プログラミングの話題です。 if〜else構文のコメントを書くときって、みなさんどのように書きますか？ 単純 if 文の場合 単純if文の場合は、ブロックの直前に書くことがよくあると思います。 例えば、Ｃ系の言語で言うと以下のような書き方です。 // ゼロの場合 if (value == 0) { funcA()； } たまに、ブロックの中にコメントを置く人も見かけます。 個人的には好きじゃないですが、まぁそんなに目くじら立てて言うほど悪い書き方でもないと思います。 if (value == 0) { // ゼロの場合 funcA()； } if else の場合 では if else の場合はどうなるかというと、それぞれのブロック内にコメントを置くのが普通だと思います。 ブロックの直前には、if else 全体の説明となるコメントを書いたりします。 （コメントの内容はともかく、位置に注目
コメントのいらないプログラムの書き方｜NZ MoyaSystem
パラメータを決める 次に関数に渡すパラメータを決めます。 関数の名前で表現されている処理を実現するには、どれだけのパラメータがあればよいか？ と考えてみましょう。 今回の例でいえば「お客さんの年齢」と「日付」があれば、すべてのチケット価格が計算できます。 ということで、age と date の2つのパラメータを渡すことにします。 function calculateTicketPrice (age, date) { } パラメータの名前も、なにを表しているかわかるようにしてくださいね。 くれぐれも「hensu」とか適当な名前をつけたり、同じ変数にぜんぜん違う値を繰り返し代入したりすることのないようにしましょう。 テストを書く 次にユニットテストを書きましょう。 テストは常に更新される仕様書です。 業務ロジックをテストに説明させておけば、関数の仕様をコメントにいちいち書く必要などありません。
Java初心者時代にコードレビューで指摘された悪しき習慣 - Qiita
Java初心者だった新入社員の頃、先輩にコードレビューで指摘された事を思い出してまとめてみた。 追記：本記事に関しては賛否含め、多くの有益なコメントを頂いています。本記事をお読みになる際は、是非コメント欄も併せてご覧下さい。 2018/04/26 コメントを参考に「何でも定数にしようとする」の見出し・本文を修正しました。@kagilinn さん、ありがとうございました。 2018/04/30 サンプルコードの判定バグってたので修正しました。@y_miz さん、ご指摘ありがとうございました。 コメントの誤記、用語誤りを修正しました。@scivola さん、編集リクエストありがとうございました。 不要なインスタンス変数を作ってしまう インスタンス変数は状態が保持されるので、バグを作り込みやすい。 「これローカル変数でよくない？」ってよく指摘された。 インスタンス変数を作る前に、ローカル変数で実
クリーンなPHPコードを書くためのガイド - Qiita
Clean Code PHP / Clean Code JavaScript 以下はClean Code PHPの日本語訳です。 Introduction Robert C. Martinの著書Clean Codeは、PHPにも当てはまることばかりです。 これはスタイルガイドではありません。 PHPで3R(Readable、Reusable、Refactorable)なコードを推進するためのガイドです。 ここに書いてあることの全てに従わねばならないわけではなく、普遍的に合意されているわけでもありません。 ただのガイドラインであり、それ以上のものではありません。 しかしこれらは、Clean Codeの著者らが長年の集合知の結果をまとめたものです。 このガイドはclean-code-javascriptに影響されました。 多くの開発者は未だにPHP5を使っていますが、このガイドはPHP7.1以
まずコードの可読性を最適化しよう | POSTD
最近では 最適化 という言葉を使う場合、GPUメモリ消費やネットワークトラフィックの最適化、などと明示的に言わない限りは、 実行時間の最適化 という意味で使われるケースがほとんどです。 自分が何を最適化しようとしているかを知ろう 私がプログラムを始めた頃、プロセッサの処理能力は遅く、メモリサイズもとても限られていて、キロバイト単位で計算されていました。ですからメモリ容量をよく考え、メモリ消費を上手に最適化しなくてはなりませんでした。大学では最適化について2つの極論を教わりました。 メモリを犠牲にして実行スピードを最適化する。 または何度も計算を繰り返して、メモリ消費を最適化する。 最近では誰もメモリについては大して気にしていません（デモシーン製作者、組み込みシステムのエンジニア、一部の携帯電話ゲームのディベロッパなどは別です）。RAMだけでなく、ハードディスクの容量についても同様です。 W
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
プログラムの可読性を上げるための条件分岐を減らす方法7個 - Qiita
C# 複数の連続usingステートメントについて"まとめ書き"を広めたい
読み手にやさしい if 文を書きたい - Qiita