宣伝
- タイトル名
- ヒカゲモノ
- ジャンル
- 謎解きゲーム
- ダウンロード
是非、興味がある方は遊んでみてください！
美しいコーディングとは？
結論
- 改行・インデント・空白が適切に行われている。
- すべての名前が適切である。
- 1行の長さを適度にしている。
- 効率の良いソースコードである。
- 命名規則が統一されている。
- 適確に記述された関数である。
- コメントが適度にある
- 人によっては、「まだある！」or「そんなにいらない！」 かもしれませんが、個人的にはこれかと思います。
詳しい説明
1. 改行・インデント・空白が適切に行われている。
- 適度に改行・インデント・空白は必要です。
- 例えば、このようなコードはどうでしょうか?
int count=0;
count++;
if(count>=10){count=0;}
- これを上記の3点を使ってみるとこうなります。
int count = 0;
count++
if(count >= 10)
{
count = 0;
}
- どうでしょうか？
- 後者の方が見やすいと思いませんか？
- このように3点を適度に使うことで見やすくなります。
2. すべての名前が適切である。
- プログラムは、基本英単語で構成されています。(言語によっては違います。)
- 適切な英単語の方が良いです。
- 皆が知っている単語が良い！
- 1つの単語で様々な意味がある物は、一番つかわれる意味で使いましょう！
- 略語はなるべく避けましょう！
- 皆が絶対知っている略語は良い！
- 例えば、URL,BGM,SE,WWW etc...
- Google翻訳を使いましょう！
- コードネーミングを使いましょう！
3. 1行の長さを適度にしている。
-
IDEやテキストエディターで折り返しをさせないようにしましょう！
-
なるべく、一画面に収めましょう！
-
長くなりそうな判断処理は、分けて判断処理をしましょう！
-
例えば、距離を調べて、距離内なら何かの処理をする場合
-
改善前コード
if(sqrt((enemyX - playerX) * (enemyX - playerX) + (enemyY - playerY) * (enemyY - playerY)) >= 10)
{
// 範囲内処理
}
- 改善コード
float x = enemyX - playerX;
float y = enemyY - playerY;
float distance = sqrt(x * x + y * y);
if(distance >= 10)
{
// 範囲内処理
}
どうでしょうか？
後者の方が見やすいですよね。
このように1行は適度にしていきましょう！
4. 効率の良いソースコードである。
- 簡単に言うと、コピペコードが多い。
- 関数分けやクラス分けなどをして、効率の良いコードにしていきましょう！
- 例えば、距離を調べる処理を汎用的関数にすれば、どこでも使えて、コピペがなくなります！
- これは、何回も何回も繰り返しコーディングを行い、改善していけばよいかと思います。
5. 命名規則が統一されている。
-
命名規則は、様々な規則があります。
-
マイクロソフトが出している命名規則
-
Googleが出している命名規則
-
統一した命名規則にしましょう！
-
すべてバラバラだとかっこ悪いです。
-
個人制作の場合
- 個人が決めて、それに沿ってコーディングしてください！
-
チーム制作の場合
- リードプログラマーが決めて、それに沿ってコーディングしてください！
6. 適確に記述された関数である。
- この意味は、関数の処理と名前が適切なのかどうかです。
- 例えば、
Draw()という関数に、処理が記述されている場合は、おかしいですよね。 - Drawの場合は、必ず描画のみの処理を記述しましょう！
- Updateには、描画の処理を記述せず、マイフレームアップデートする処理を記述しましょう！
- このように関数の名前とその内容が違うと、人が見たときにびっくりします。
7. コメントが適度にある。
- 嘘のコメントは書かない！
- 抽象的なコメントも書かない！
- 適切なコメントを記述しましょう！
- 第三者が見てわかるコメントにしましょう！
- コメントの記述方法は、人によって様々です。
- 自分の場合
// ----------------------------------------------
// 処理内容
//
// 具体的な使い方
//
// 戻り値について
//
// ---------------------------------------------
int Func()
{
return 0;
}
- 自分なりの他人に伝えれるコメントの書き方をしてみましょう！
以上になります。