プログラミングスタイル

自動インデント（字下げ）機能 (mule)

mule の C 言語モードでは、行頭で[Tab] キーを押すと適切な空白が挿入される。
mule 画面の右下に (C) と表示されていればC言語モードである。
エディタを C 言語モードにするには : M-x c-mode
すでに作ってあるソースファイルをインデントしなおすには：
ファイル全体をリージョンとして指定し、M-x indent-region を実行。
具体的には下記のようにすればよい。
1. M-x c-mode
2. M-<
3. C-space
4. M->
5. M-x indent-region

自動インデント（字下げ）機能 (Microsoft Visual C++ 5.0J)

すでに作ってあるソースファイルをインデントしなおすには：
ファイル全体を選択し、編集→高度な操作→選択範囲の書式自動設定

ファイルのコメント

各ソースファイルの先頭に、プログラムの目的と使い方をコメントとして書いてください。なるべく具体的に。
日頃よく使うコマンドを man コマンドで調べて、参考にしましょう。
バージョン管理システムを使う予定があれば、$Log: $ と書いた行をおいておけばよいでしょう。
```
/*
 * XXXX を行うプログラム by 自分の名前
 * （簡単な機能と使い方）
 * $Log: $
 */
       
```

各関数の先頭にも説明を書いてください。
以下はひとつの例です。

/* 
 * 機能
 *   HTK 形式のモデルファイルを HMMSet 構造体に読み込む
 * 入出力
 *   O : hmmset    読み込む構造体
 *   I : filename  モデルファイル
 *   I : modelname モデル名（文字列）
 * 返り値 
 *   OK    : 0
 *   ERROR : -1
 */
int LoadSingleModelFile( HMMSet *hmmset, char *filename, char *modelname )
{
     (以下、関数の中身)
}

Java におけるコメントの例 (javadoc)

JDK1.1.1 日本語ドキュメントより引用。

この形式に従えば、javadoc というツールを使って .java ファイルから .html ファイルを自動生成することができる。

クラスコメントの例

/**
 * A class representing a window on the screen.
 * For example:
 * <pre>
 *    Window win = new Window(parent);
 *    win.show();
 * </pre>
 *
 * @author  Sami Shaio
 * @version %%I%, %%G%
 * @see     java.awt.BaseWindow
 * @see     java.awt.Button
 */
class Window extends BaseWindow {
   ...
}

フィールドコメントの例:

    /**
     * The X-coordinate of the window.
     *
     * @see window#1
     */
    int x = 1263732;

メソッド doc コメントの例

    /**
     * Returns the character at the specified index. An index 
     * ranges from <code>0</code> to <code>length() - 1</code>.
     *
     * @param     index  the index of the desired character.
     * @return    the desired character.
     * @exception StringIndexOutOfRangeException 
     *              if the index is not in the range <code>0</code> 
     *              to <code>length()-1</code>.
     * @see       java.lang.Character#charValue()
     */
    public char charAt(int index) {
       ...
    }

レイアウト

空白やカッコを上手に使い、視覚的にすぐれたレイアウトによってプログラムの論理的構造を表現する。

プログラムの論理構造を正確に表現する
プログラムの論理構造の表現が一貫している
読みやすさが改善される
プログラムの変更がレイアウトに与える影響が少ない

下の例はレイアウトが人間とコンピュータに異なって解釈される。

     for ( i = 0; i < MAX_ELMTS; i++ )
         LeftElmt   = Left[ i ];
         Left[ i ]  = Right[ i ];
         Right[ i ] = LeftElmt;

次の例では、行 A で制御機構を開始し、行 D で制御機構を終了する。ふたつの行の間を直線配置することで視覚的まとまりがはっきりする。

A     ■■■■■■■■■■■■■■■
B         ■■■■■■■■■■■
C         ■■■■■■■■■■■
D     ■■■

C 言語でこれを表現すると、次のようになる。 for 文, while 文などでも同様である。

A     if ( 条件式 ) {
B         ■■■■■■■■■■■
C         ■■■■■■■■■■■
D     }

参考文献： S.McConnell "コードコンプリート" （Microsoft Press,アスキー出版局）

Last modified: Fri Dec 17 15:39:28 1999