Go コードのレビュー時によくされるコメント

CodeReviewComments から Go コードのレビュー時によくされるコメントについて。

gofmt

gofmt またはそのスーパーセットである goimports を実行すること。goimports は gofmt に加えて import の追加と削除も行う。

コメント文

http://golang.org/doc/effective_go.html#commentary を参照。宣言に対するコメントは少し冗長に見えるかもしれないけど完全な文にする。そうすれば godoc できれいに整形される。次のように説明するものの名前から始めピリオドで終える。

// A Request represents a request to run a command.
type Request struct { ...

// Encode writes the JSON encoding of req to w.
func Encode(w io.Writer, req *Request) { ...

Read More


initialism(頭文字語):各単語の頭文字(initial letter/word)をつなげたもので、アルファベットを一つずつ発音するもの。最近ではネット語(Netspeak)で多用されている。
 例:GP(=general practitioner):一般開業医、RN(=registered nurse):正看護婦、3R’s

acronym(頭字語):頭文字語の中でも、とくに一つの単語のように発音が可能なもの。
 例:NASA(=National Aeronautics and Space Administration):米航空宇宙局

ちなみに、acronymの語源は、acro(先端・頂点・高所)+nym(=name)→「単語の各先端を集めてできた名詞」です。頭文字を並べただけのinitialismの-ism(~表現)とは違い、-nymに「単語化されている」という特徴がよく現れていると思います。

頭文字語と頭字語: やまちゆうの英語ブログ

Source: rhymosphere.cocolog-nifty.com


キャメルケースなんて死ねばいいのに

変数や関数のキャメルケースなんて死ねばいいのにと思っていた。リーダビリティの面で。

CamelCase と camelCase は明らかに lower_case_with_underscores や UPPER_CASE_WITH_UNDERSCORES より読みにくい。英語は単語がスペースで区切られる言語なんだから、大文字・小文字で区切るよりアンダースコアで区切った方が見やすいのは当然だと思っていたし、実際にそう感じていた。

でもそうでもないらしい。CamelCase の Wikipedia によると

a study that specifically compared under_score style and CamelCase found that camel case identifiers could be recognised with higher accuracy among both programmers and non-programmers, and that programmers already trained in CamelCase were able to recognise CamelCase identifiers faster than underscored identifiers.

らしい。でもにわかには信じがたい。


●前提挿入→「契約をする前によく検討してください」のように契約する意思を表示しえいないのに「契約」を前提に契約後のイメージを否応無しに持たすことができる。契約のイメージに自然に誘導できる。

>前提挿入の例文① 時間に関連する言葉を使う

「~の前に」「~のあとに」「~しながら」「すでに」「まだ」

本当にして欲しいことを前提にする。

例文「まだ高い税金を支払うのですか?」

>前提挿入の例文② 順番に関連する言葉を使う

「最初に」「次に」「最後に」

>前提挿入の例文③ 選択肢を与える

「AとBどちらにしますか」

>前提挿入の例文④ 自分が気付いた形をとって前提にする

「会社にお金を残すことの重要さは私が良く知っています」

「私は~知っています」「私は~注目しています」「私は~と理解しています」

「私は~に気付いています」の「~」の部分に伝えたいメッセージを入れる

『相手を洗脳する文章テクニック』(日本実業出版社) 宮川 明 - 森の本屋さん

Source: nichimen-recruit.com


●前提挿入
行動心理学とかでよく使われる手法の1つ。あからさまにやると逆に不信感に繫がる。
(買うことを前提として)黒色がいいですか、白色がいいですか? みたいな。子供に歯磨きをさせたいとき→「歯磨きはお風呂入る前がいい? それとも入った後がいい?」みたいに訊く。
ただ、これは子供には効くかもしれないが、今時はバレバレだし不信感につながるかもしれない。
「前提挿入」は単に「はい/いいえ」質問を、どちらを選んでもこちら側に有利になるような択一質問に代えることではない。例えば、この勉強会の開始時に先生が、「これから2時間の勉強会で勉強してもらうのに、皆さんね、楽な姿勢とってください」というようなことを言ったが、これは「勉強する」ということが前提挿入になっている。無意識に「勉強する」ということを植え付けている。こういうのも前提挿入。”

NLP(Neuro Linguistic Programming)をほんのちょっと教えてもらった | papativa.jp

Source: papativa.jp


小学2年の頃の私の話です。
私は、虐められてる子がいる。とゆうことを母親に話したときに、「イジメちゃ駄目だよ」と言われ、ショックでした。お母さんは、私が虐めるような子に思うの?私が

悪い子だと思ってるの?という意味でショックでした。

そして、その後虐められてる子に意地悪を一回だけしたことがあります。したあと、変な感じになり、意地悪したことを後悔しました。
何故意地悪をしたのか思い出せません。
私は、何故意地悪をしてしまったのでしょうか?

小学2年の頃の私の話です。 私は、虐められてる子がいる。とゆうことを母親に話し… - Yahoo!知恵袋

Source: Yahoo! Japan


「トイレをきれいに使っていただきありがとうございます」と「イジメちゃだめよ」、共通した問題があるのではないでしょうか?

http://detail.chiebukuro.yahoo.co.jp/qa/question_detail/q1410648424…
(トイレをきれいに)
http://detail.chiebukuro.yahoo.co.jp/qa/question_detail/q1312681413…
(イジメちゃだめ)

前者は、まず、(本気でないが)、対象が善人であるということを訴えて、その善性に訴える(言い方を変えれば、「悪性」を逆説的に牽制する)
後者は、善性も悪性もなく、ただ安全牌を引く、ただ目の前の物事におびえて恐怖する、取引も逆説もない。

ただ、これが逆になって何が悪いかと思うんですがね。

「トイレはきれいに使わなきゃだめです」
「あんたはイジメるなんてことはないのは私はよく知ってるわ(^_-)-☆」

まぁ、半世紀前まではこんなばかげたことはなかったわけですがね。遮断機がない踏切には
『止まれ!視よ!』
という命令形全開であった。

「トイレをきれいに使っていただきありがとうございます」と「イジメちゃだめよ」… - Yahoo!知恵袋

Source: Yahoo! Japan


1 2 3 4 5