グローバル修飾リスト: 現状の登録ルールを記載 (#1472)

Author: faithandbrave

GLOBAL_QUALIFY_LIST.txt

@@ -1,3 +1,43 @@
+# グローバル修飾リスト
+#
+# 【概要】
+# このファイルは、Webサイト全体に適用されるコードブロック中の識別子への修飾である。
+# 各ページのコードブロックへの修飾のうしろに、このファイルの内容が追加され、適用される。
+# 個別ページで指定される修飾の方が優先順位が高くなるため、個別ページで指定されている修飾は上書きされない。
+# グローバル修飾リストは、ページ執筆者の作業負担を減らすための機能である。
+# コードブロックへの修飾の構文は、 /start_editing/markdown_cpprefjp.md を参照すること。
+#
+# 【登録ルール】
+# 1. 識別子への修飾として頻出するものを登録する
+#     1.1 頻出とは基本的にはヘッダを跨いでよく出てくるもの
+#     1.2 ただし、ヘッダ内のサンプルコードや使用で頻出し、個別ページでの修飾が作業負担になる場合はその限りではない
+# 2. 標準ライブラリのヘッダファイル、モジュールはすべて登録する
+# 3. 登録順は、アルファベット順
+#     3.1 ライブラリ内でさらにアルファベット順
+#     3.2 ただし、同じ機能を名前空間なし・ありの両方を登録する場合、名前空間ありを先に登録すること。
+#         優先的にコード修飾を適用し、名前空間を含む完全名に対して部分的に修飾されないようにするため。例：
+#         * std::chrono::milliseconds[link …]
+#         * chrono::milliseconds[link …]
+#         * milliseconds[link …]
+#     3.3 所属するライブラリに識別子を登録すること
+#     3.4 ライブラリ内の識別子は、インデントさせること
+#     3.5 インデントはグローバル修飾リストの読み込み時に自動的に削除されるため、インデント自体に構文的な意味はない
+# 4. 名前空間は基本的につける (主にサンプルコード用)
+#     4.1 ただし、宣言や仕様で頻出する場合には、名前空間なしのものも登録する
+# 5. メンバ関数を登録する場合は、合意された衝突しない変数名を使用すること
+#     5.1 std::vectorはv、v1、v2、v3
+#     5.2 std::initializer_listはil
+#     5.3 std::valarrayはva
+#     5.4 std::threadはt、t1、t2
+#     5.5 std::jthreadはjt
+#     5.6 std::error_codeはec
+#     5.7 std::error_conditionはecond
+# 6. 名前空間の略称は、合意された衝突しない名前を使用すること
+#     6.1 std::filesystemはfs
+# 7. オーバーロードされている名前は、優先度の高いプライマリ宣言をグローバル修飾リストに登録する
+#     7.1 ライブラリごとにオーバーロード・特殊化されているものはグローバル修飾リストに登録せず、個別ページで指定する
+#         (std::begin/std::end、std::common_typeなど)
+
 * floating-point-type[italic]
 * implementation-defined[italic]
 * import std;[link /module/std.md]