前提・実現したいこと
「ツール解決」か、「コーディングルール解決」か悩んでいます。
アドバイス頂けると助かります。
発生している問題・エラーメッセージ
(1)「コードの右側余白にコメント文を入れて書いた方が可読性が良い。処理の流れもコメントを読んだ方が理解が早い」というタイプの人と
リポジトリのリビジョン間の差分表示で、
(2)「右側余白コメントだけ変更されるとコードが変更されていないのに、差分として表示されてしまうので、
コードレビューのための可読性が悪すぎる」というタイプの人がいます。
該当のソースコード
(1)
a++; // インクリメントします。
(2)
/// センサーが反応したのでインクリメントします。
a++;
頂きたいアドバイス
A) 差分比較には winmarge を利用しているのですが、変更箇所の色分けを「行」ではなく「文字のみ」にする方法をご存知の方がいらっしゃいましたらアドバイス頂けると助かります。
B) ソースの上から下まで延々コード内容を「右側に日本語化したコメント」として書くことで、
「右側のコメントで処理の流れが分かりやすい」との見解らしいのですが、
そもそもコメントを読まなくても分かるコードを書いた方がいい気がしていまして…
コーディングルールとして「右側コメント禁止」は乱暴すぎるでしょうか?
以上2点、アドバイス頂けると助かります。
宜しくお願い致します。
回答5件
あなたの回答
tips
プレビュー
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。
2018/08/03 02:23
2018/08/03 03:03
2018/08/03 04:01
2018/08/03 09:04