(cpprefjpを編集するには および cpprefjpでのMarkdown記法の制限と拡張 を先に読んで下さい。)
(
サンプルコードは文章中のどの部分で書いても大丈夫です。閲覧者の理解を助けるために必要だと感じたところで入れてください。
その際拡張構文であるexampleタグをルールに従って付け、コンパイル・実行可能にすることを検討してください。
)
概要
(ここには、名前付き要件の概要を記述します。必須事項です。)
(必要な項目を省略する場合には、「(執筆中)」と書いておいてください。)
Requirementは、型がxxであることを表す要件である。
(標準ライブラリのどの機能がこの要件を要求するかを記述してください。読者が、なぜこの要件を知る必要があるかを判断できるようにします。)
要件
(ここには、名前付き要件で要求される内容を記述します。)
(項目数が多い要件では、省略できない項目と省略できる項目を表に分けて記述します。省略できる項目には、省略した場合の既定の定義を併記してください。)
対応する標準コンセプト
(ここには、この要件に対応する標準ライブラリのコンセプトへのリンクと、要件との違いを記述します。対応するコンセプトがない場合は、項目を削除してください。)
std::concept_name(C++20) (コンセプトのリファレンスページへのリンクにします)
この要件との違いは以下である。
- (要求する式の違い、意味論の違い、コンパイル時に検査できるかの違いなどを箇条書きで記述します。)
(要件とコンセプトのどちらがどちらを含むかを明記してください。)
備考
(ここには、名前付き要件を説明するにあたっての、補足事項を記述します。とくになければ、項目を削除してください。)
Requirementに該当する型
(ここには、名前付き要件に該当する型を列挙します。とくに必要がないと判断した場合、項目を削除してください。)
- xx型
- yy型
例
自作のxxを実装する (最小要件を満たす実装)
(要件を満たす型を自作する例を、最小要件を満たす実装と、要件を完全に満たす実装の2つの見出し3に分けて記述します。読者が自作の型を書けるようにすることが目的です。)
(サンプルコードには、各項目が何を意味するかの解説コメントを付けてください。)
(省略できない項目だけを定義した実装を示します。)
// (インクルードとmain()関数を含む、実行可能なサンプルコードを記述してください。そのようなコードブロックにはexampleタグを付けます。)
// (標準ライブラリのどの機能に渡せるかがわかるように、実際に使用するコードを含めてください。)
#include <iostream>
int main()
{
}
(コードブロック中の識別子のうち、GLOBAL_QUALIFY_LIST.txtに登録されていないものには、コードブロック直後にリンクを記述します。)
出力
自作のxxを実装する (要件を完全に満たす実装)
(省略できる項目もすべて明示的に定義した実装を示します。省略した場合の既定の定義と同じ内容であることを述べてください。)
#include <iostream>
int main()
{
}
出力
(ここには、サンプルコードの実行結果を記述します。何も出力がない場合は、項目を削除せず、空の出力にしてください。)
(実行結果が処理系・実行環境によって異なる場合は、項目名を「出力例」に変更し、可能であればその理由も併記してください。)
関連項目
(ここには、その機能と関連のあるcpprefjpサイト内の項目へのリンクを記述します。とくに必要がないと判断した場合、項目を削除してください。)
参照
(ここには、その名前付き要件を理解するにあたっての参考資料や、関連する機能へのリンクを記述します。とくに必要がないと判断した場合、項目を削除してください。)