表記規則

このドキュメントでは、以下のフォント規則を使用しています。

表記	説明	例
斜体	新しい用語、用語の意味、プレースホルダー、マニュアルのタイトルを示します。	ファイル名はベース名と拡張子からなります。
等幅	ディレクトリー・パスとファイル名、コマンドとコマンドオプション、関数名、メソッド、クラス、本体内のテキストのデータ構造、およびソースコードを示します。	ippsapi.h \alt\include okCreateObjs() 関数を使用して … printf("hello, world\n");
[ 項目 ]	角括弧は、囲まれている項目がオプションであることを示します。	Fa[c] は、Fa または Fac です。
{ 項目 | 項目 }	中括弧は、中括弧内にリストされている項目のうち 1 つだけを選択する必要があることを示します。縦棒 ( | ) で項目を区切ります。	X{K | W | P} は、XK、XW、または XP を示します。
“[” “]” “{” | “ }” “|”	メタ文字を引用符で囲むと、前述の構文の意味は無効になり、文字はリテラルとして解釈されます。	角括弧で囲まれた文字 X に続いて、オプションで文字 Y を指定することを示します。
…	省略記号は、前の項目を複数回繰り返すことが可能であることを示します。	ファイル名 …1 つ以上のファイル名を指定することを示します。
,…	カンマから始まる省略記号は、前の項目をカンマで区切って複数回繰り返すことが可能であることを示します。	単語,... は 1 つ以上の単語が指定できることを示します。2 つ以上の単語を指定する場合は、単語をカンマで区切ります。

クラスメンバーは、実際にどのように実装されるかではなく、クライアントに見えるようにクラスを記述する略式クラス宣言によって要約されます。例えば、これはクラス Foo の略式宣言です。

class Foo { 
public: 
    int x(); 
    int y; 
    ~Foo(); 
};

実際の実装は次のようになります。

namespace internal { 
    class FooBase { 
    protected: 
        int x(); 
    }; 

    class Foo_v3: protected FooBase { 
    private: 
        int internal_stuff; 
    public: 
        using FooBase::x; 
        int y; 
    }; 
} 

typedef internal::Foo_v3 Foo;

この例は、実際の実装と略式宣言で異なる2つのケースを示しています。

• Foo は Foo_v3 の typedef です。

• メソッド x() は保護されたベースクラスから継承されます。

• デストラクターは、コンパイラーによって生成される暗黙のメソッドです。

略式宣言は、実装とは特に関係ない部分を気にすることなくクラスを使用するために、何を知っておく必要があるかを示すためのものです。