ユニケージ流コメントの書き方が、ひどすぎて失笑at TECHユニケージ流コメントの書き方が、ひどすぎて失笑 - 暇つぶし2ch■コピペモード□スレを通常表示□オプションモード□このｽﾚｯﾄﾞのURL■項目テキスト1:デフォルトの名無しさん 22/10/15 11:56:45.81 Va9+8zVB.net https://uec.usp-lab.com/JOURNAL/CGI/JOURNAL.CGI?POMPA=SAHOU_journal10 ■ 「正しく動く」だけでは意味がない > 「コンピュータ言語は人間のための言語なのだから、人間が読んで分からない事柄には > 人間の言葉で補足を加えねば意味がない」ということである。 意訳 ソースコードは人間が読めないから、日本語を書く ■ 上手なコメントを書くための心得 > リスト1が悪い例、リスト2がそれを修正した例である。これらを見ながら解説していこう。 リスト2 がクソすぎる ■ 不用意なカタカナ語禁止 > 「担当者」は英語でchargeというが分かりにくい。分かりにくいからコメントがいる。 > そうするくらいならローマ字でtantouと書いて済ませる方がよっぽどいい。 ■ 冒頭に、自ファイル名を書け ■ 冒頭に、日付・連絡先を書け ■ 「マジックナンバー」の意味を書け ■ 同じ事でも、離れた所にはもう一度書け DRY原則。同じことを複数書くな。同期が取れなくなる ■ 「別途資料参照」のみならず、内容も書け ■ if文条件も丁寧に書け ■ 英語綴りを間違えるな、自信がないならローマ字で 自信がないなら、SHI・RA・BE・RO☆ > 確かなことは、「人間にとって分かりやすい書き方」 意訳 俺たちはプログラマじゃない。素人なのでプログラミングのことはわからない 日本語プログラミング言語が羨ましい 次ページ最新レス表示レスジャンプ類似スレ一覧スレッドの検索話題のニュースおまかせリストオプションしおりを挟むスレッドに書込スレッドの一覧暇つぶし2ch