レビュー前に直して欲しい日本語の問題点８つ - Qiita

私はウンザリしています。 「○○対応」は曖昧なのでやめてください。「○○が■■になるバグを修正した」の方が直接的です。 こんな指摘を、新人が入ってくるたびにコードレビューやドキュメントレビューで繰り返しています。 しかも、なぜか、新人は揃って同じような分かりにくい表現をつかってきます。 なんなんでしょう？工学部では、こんな言葉遣いをするよう指導してるんでしょうか？ 「レビューを依頼する前にこれを読んどいて！」と言える記事なり本なりがあれば良かったのですが、良いものが見つけられなかった（ご存知なら教えてください）ので、とりあえずレビューでよく指摘する日本語の文章の問題点や変な表現ポイントを列挙しました。 なお「コメントは必要十分な量を書く」「チケット番号やWikiのURLを書く」といった、良く知られた・日本語に限定されない話題は省略しています。 1. 俗称を使わない・造語しない 製品名・機能

[monorod]

わかるんだけど、言い回し云々よりも、書くべき情報が欠落していないかどうかの方が大事だと思う。機械的に体言止めを直したからといって良いコメントになるわけじゃないでしょ？別に関西弁でコメント書いてもええで

[mouki0911]

エビデンスが無い、って通じないの？

[otihateten3510]

うるせえ！拝承！！！！

[satohu20xx]

このレベルでツッコミを受けるとめっちゃ萎えるなぁ。。。

[manaten]

わかりづらいコメントのわかりづらさって、ここに挙げられてるような文法的な話じゃないと思うんだよなあ。whyが書かれてない、howしか書かれてないようなコメントはわかりづらい

[junglejungle]

どおおおおおおーーーーーでもいいいいいいいいいそんなくだらない指摘するくらいならコードレビューすんな。マイクロマネジメントするヤツはとっとと絶滅してくれ。

[yellowmikan]

"チケット#143567の不具合" \ これこそ体言止めでは。「不具合を修正した」のか「不具合を確認している」、どちらなのかわからない

[azuk1]

例のほとんどがそもそもコードに書くコメントではない

[kifoo]

そもそもコミットログは英語で書くべき

[Palantir]

同意できないのも多いけどコメント大事なのはわかる。

[John_Kawanishi]

｢新人はなぜみんな同じような分かりにくい表現をつかってきます｣｢工学部では、こんな言葉遣いをするよう指導してるんでしょうか？｣卒検だか卒論かいて卒業してきて入ったはずなのになんなんだろう自分も(焦

[tettekete37564]

4,5 以外はホンット大事。4 は書き忘れてるパターンが多いの書いてあるだけ御の字。5 は TPO による。5W1H とまでは言わないものの、一文はひと組の主語述語で定義的に書いてくれ。定義とは範囲を明確な粒度に限定すること

[Magicant]

レベルの違ふ人と仕事をするのは大変ですねー

[kamenashi1982]

“これらの定型句は情報を増しません。口語での「ええっと」「その〜」などと同じ、心のうめきに過ぎないからです。” ワカル〜

[treeapps]

人間にこれらを指摘されると嫌な気分になって反発されそうなのと、その人独自の言葉遣いを強要するだけで終わりそうなので、どうしてもやるならRedPen等で機械的に緩めにチェックする仕組みとかを作った方がよさそう

[gen0083]

思わずやっちゃってることあるなあ。 書いてあることはごもっともだと思う。レビューに限らない話。

[northlight]

この程度の日本語運用能力もない自称エンジニアのあまりに多いことよ。

[nagabow]

日本語が不自由な人が多いからなぁ

[vanbraam]

一番欠けてるのは「想定読者」の情報.想定読者が決まれば,この文書の指摘の半分くらいは無意味になる気がする

[kts56]

「〜するべきである」と「〜しなければならない」って同じ意味じゃないの？

[hiro_curry]

これが仕様書だったら気になるかな。プログラムはプログラミング言語だけで作るわけではないので。

[lbtmplz]

いきなり言葉遣い指摘してくる奴か、大抵のこれらは本題の後に追加で指摘すべき

[crexist]

コメントが大事なのはわかるが指摘がくっっっっぅっそしょーもない。 別にコード自体を客に見せる訳じゃ無いならこの神経質さは無意味。芸術品作ってるんじゃ無いんだぞ

[diveintounlimit]

正しい手斧の磨き方（皮肉

[lnimroder]

知見が得られた がわからんってどういうことだ。国語の成績2ぐらいだったのか？

[nyoron0128]

批判が多いけど個人的には割と同意。コードレビューに限らず、限られた文字数内で必要な情報を詰め込んで伝達齟齬が発生しないように文章を作るのは、意識していないとなかなかできない。

[kiyo_hiko]

わかる。でもコメントにそこまでコスト掛けるより帰る。せいぜい意図と注意点書く程度なので。(例えば:ここで速度稼ぎたい→再描画をoffしている。finallyでonし直すこと、など)。文書作成ならそれなりにコスト掛ける

[eru01]

なんやこのバイト数の無駄。釣りするならもうちょっとまじめにやれや。コメントにPython3.7の入れ方なんて書いてあったらその時点でこいつの座席ごとgit reset --hardやろ

[msh5_h]

厳しいレビューで切磋琢磨できるチームに居るほうが伸びるよね

[htnmiki]

私はエンジニアではないので議事録の話をすると何社かで書いた経験から各社各現場で記述の粒度が違うので最初にそのレベル感を確認しないと二度手間になる。現場の作法が必ずあるからねえ。

[hamati666]

はてブにあがるQiitaの記事は、ブコメで叩かれすぎてる気がするわ

[aw91]

コメントは大事ではあるが、ここで挙げられている例が適当だとは思えない

[honma200]

"新人が入ってくるたびにコードレビューやドキュメントレビューで繰り返しています。" そら新人だからな。解決策は1と2で、チームの言語に合わせるくらい。7とかはOSSでもFIX:とかclosed:とか使うからねぇ

[gabill]

こういうのにこだわり始めたらなんかの兆候だと思う。

[paradisemaker]

ものすごく大事なこと

[Tomato-360]

大変そうだなって思った。コミュニケーションが足りないのかも。

[Lumin]

死ぬほどどうでもよくてワロタ。こんなことレビュー時に何度も言う奴がいたら即無能認定だし、そもそもコメントに書かないような例ばっかり挙げてるのどうなの

[tofy]

そういうことならもうなんか英語で書いたほうがいい気がする

[fuji_haruka]

レビューコメントでこういう日本語の問題を指摘されるとイラッとは来るけど、各々が個人的に気をつけるのは良い習慣と思う。

[Nyoho]

助動詞のところ助動詞じゃなかった。日本語わかってない可能性がある。