タグ

開発とコメントに関するmohnoのブックマーク (5)

  • コードレビューの「純粋に質問ですが」は「勝手に指摘だと受けとってよくわからん修正するんだろ?質問なんだよ!修正すんなよ!」という意思表示な説

    すえなみ @a_suenami コードレビューの「純粋に質問ですが」は表現を柔らかさ目的でなく、「お前は質問だって言わないと勝手に指摘だと受けとってよくわからん修正するんだろ?質問なんだよ!!修正すんなよ!」という意思表示で、むしろ元より殺伐となってる可能性すらあります。

    コードレビューの「純粋に質問ですが」は「勝手に指摘だと受けとってよくわからん修正するんだろ?質問なんだよ!修正すんなよ!」という意思表示な説
    mohno
    mohno 2023/02/15
    文字だけでは疑問なのか反語なのか分からんよね。はてブでもタグに「素朴な疑問」って付けたりする。/説明できるくらい自信を持てよ。/「なんで〇〇なんですか?」は反語っぽい。/「なんで修正したんですか?」
  • コーディングルールはマジでしっかり決めろって話

    どうも、フリーランスエンジニアの人です。 今まで関わったプロジェクトにおいてコーディングルールが曖昧だった環境で苦労したので、例に出しながら振り返ろうと思います。 ※ 記事に登場するコード例は実際に存在するコードではありませんがヤバさは忠実に再現しました。 2022/11/5 追記 曖昧かつ実態のズレた変数名 変数の命名というものはエンジニアによって少々偏った傾向が見られますが、その変数が指し示す実態と命名に大きなズレがなく、主旨が伝わればエンジニアリングにおいて大きな問題はないはずです。 ですが、世の中には曖昧かつ実態と一致しない変数名が書かれたプロダクトコードが存在します。 以下のコードをご覧ください。 ※ 今回はJSを例に出します // ユーザーのデータを取得 export const getUserData = async (id) => { const res = await

    コーディングルールはマジでしっかり決めろって話
    mohno
    mohno 2022/11/06
    なんか“コメントが本番”っぽい。/デタラメな英語を使うと通じない、みたいなことはある。/チームで開発するときは「誰が書いたか分からないような(クセのない)プログラミングが望ましい」と言うことはあるね。
  • JSON にもコメントを書きたい - Qiita

    JSON の構文は至ってシンプルです。 JSON は名前(キー)と値のペアがセットになった「オブジェクト」から構成されています。 キーはダブルクォートでくくられた文字列です。 値はダブルクォートでくくられた文字列、数値、真偽値、null 値、配列、またはオブジェクトです。 キーと値はコロン( : )で区切ります。 ペアとペアの間はカンマ( , )で区切ります。 前後を中括弧( { , })で挟みます。 { "文字列": "文字列", "数値": 0, "真偽値": true, "null値": null, "配列": [ "要素1", "要素2" ], "オブジェクト": { "キー": "値" } } そう、JSON にはコメントを記載するための構文がないのです。近年では設定ファイルなどで利用されることも多い JSON ですが、コメントによる説明が不要なキーを名付けることは現実的ではあり

    JSON にもコメントを書きたい - Qiita
    mohno
    mohno 2020/02/17
    「JSON にはコメントを記載するための構文がない」←そうなんだ。直接手書きすることはなかったけど、そういう使い方するならコメント文は欲しかったね。
  • 「コメントは書くな」 - Qiita

    同僚だったロシア人のMはとにかくすごいエンジニアで、給料について社長ともめていたかと思えば、スーパーデプロイシステムを一人で作り上げていたり、Python推しの会社の中で、各所を説き伏せてTypeScript on node.jsの導入を進めたりしていた。 皮肉屋で、だれかれかまわず議論をふっかけていたが、とにかく仕事が速くて品質がよいので絶大に信頼されていた。 私は開発者としてMから様々な教えを授けられた。当時私はPHPerあがりのひよっこで、日々ダメコードを生産していた。 ある日Mにコードレビューを依頼すると、こんなことを言われた。 「堀さん!ソースコードにコメントを書いてはいけない!」 // connect to the database named "mysql" on the localhost val driver = "com.mysql.jdbc.Driver" val u

    「コメントは書くな」 - Qiita
    mohno
    mohno 2019/07/01
    もちろん例外はあるだろうけど、「コメントを必要とするようなソースコードの書き方をするな(変数名とかマジックナンバーとか)」ということだろう。「きれいなコードを書かなければならない」
  • なぜ我々はいまだに文字列でコメントを書いているのか - Qiita

    あるいは、画像コメントのすすめ。 TL;DR 画像コメントのほうが意図が伝わりやすい 画像URLからツールチップで画像表示してくれるVSCode拡張機能があるよ その場で画像を作るSVGエディタもあったよ 問題提起 みなさんは、少し複雑なアルゴリズムを書くことになったときどうしていますか。 たいていの場合、いきなりコーティングに取り掛かるのでなく、 雰囲気をつかむためメモやホワイトボードに落書きすると思います。 特に幾何計算では簡単なものでも図を描いた方がいいです。こんな感じ。 図を書いたら後はコードに落とすだけです。 ね、簡単でしょう? // 指定した直線を対称軸としたときの指定した点の鏡映位置を返す function flipVectorByLine(p: Vector, line: Line): Vector { // TODO: よくわかるコメントを書く const ln = ne

    なぜ我々はいまだに文字列でコメントを書いているのか - Qiita
    mohno
    mohno 2018/09/22
    手描きで図を描くことはあるけど取り込むのは面倒だからなあ。リンクですむならURL書いておくけど。あと図だけだと検索しにくいというのはある。「VSCodeにはImage previewという拡張機能があり」
  • 1