綺麗なコードを書くコツは


うさぴょん  2024-06-07 06:51:35  No: 151505  IP: [192.*.*.*]

独学でDelphiを勉強しています。
参考となるソースコードを見ながら勉強しているのですが、Delphiでコードを書く際、
誰が見ても分かりやすく綺麗で、そのコードの内容を理解できるような書き方を身に付けたいです。
標準的な書き方のルールはあるのでしょうか。(コメントの書き方など)
もしありましたら教えてください。

編集    削除
igy  2024-06-07 07:11:06  No: 151506  IP: [192.*.*.*]

リーダブルコード
https://www.oreilly.co.jp/books/9784873115658/
が良いかもしれません。
(ただ、例示されているコードは、Delphiじゃないですが・・)

編集    削除
HFUKUSHI  2024-06-07 08:47:51  No: 151507  IP: [192.*.*.*]

英語ですが

Delphi’s Object Pascal Style Guide - RAD Studio
https://docwiki.embarcadero.com/RADStudio/Athens/en/Delphi%E2%80%99s_Object_Pascal_Style_Guide

個人的な意見ですが、
・どのような状況でも同じ書きかたで一貫性を保つ
・自分のコードも他人のコードも同じように見る/読む(自分のコードも1カ月経てば他人のコード)
・警告もヒントも残さない
・Gitなどを使うことで、不要になったコードをコメントとして残さない(Gitはローカルでも構わない)

編集    削除
vram  2024-06-07 09:14:32  No: 151509  IP: [192.*.*.*]

明確なルールというわけではありませんが
コード補完で出てくるソースコードはメーカーが望んでいる書き方なのかなぐらいには思います

書き方ではありませんが自分の場合
with は使わない
ソースコード1行は画面内に収まる長さとする
関数自身の行もできる限り画面内に収まる行数とする
とりあえず作っただけの関数でもコメント1行で何をしてるのかぐらいは書く
ぐらいでしょうか?

ある程度の段階までは書き方のルールが見えてこないDelphiですが
オブジェクト指向を学ぶ段階になると突然暗黙のルールがたくさん出てきますのでご注意を

編集    削除