[規格] 基本用語、慣用語、略語

[saki7]

C++標準規格における基本用語と、C++の慣用語の解説を書いてください。

略語表もまとめてください。 https://github.com/cpprefjp/site/wiki/略語表

プログラムに関するもの

• 適格 (well-formed)
• 不適格 (ill-formed)

振る舞い・評価順序に関するもの

• 実装依存/処理系定義 (implementation-defined behavior)
• 未規定/不定 (unspecified behavior)
• 未定義 (undefined behavior, UB)
  （鼻から悪魔）

アルゴリズムに関するもの

• 安定 (stable)
  （挿入、ソート）

規格に関するもの

• 未規定 (unspecified)
  （型など）
• 欠陥 (defect)
  参考: http://faithandbrave.hateblo.jp/entry/2017/08/10/120545

慣用語、英語、ラテン語

• 合法
• 違法
• NB
• e.g.
• i.e.

書く場所は、 article/ 階層以下に新しい記事を作れば良さそうです。作ったら、GLOBAL_QUALIFY_LISTも更新して自動リンクにしてください。

これらの用語は、今のcpprefjpでもそこそこ使用実績があり、日常的に触れるものです。英語の用語は、日本語解説サイトとして最低限必要だと感じる基本的なものを独断で入れました (@saki7)

解説の雰囲気として、中学一年生の教科書程度の平易さが望ましいと思います。

出典として記載するのはなるべく現行の標準規格に留め、出典を付加する場合でも記事本文で理解が完結するようにしてください。

[faithandbrave]

GLOBAL_QUALIFY_LISTはコードブロックに対してのみ適用されるので、文章には適用されないですよ。

[saki7]

@faithandbrave たとえば unspecified などはコードブロックでよく出て来ますが、今は斜体になるだけなので、用語を知らないと少し引っかかりがあると思います。自動リンクで用語解説に飛べると良いかなと。

本文で「未規定」などの用語が出てきて「あれっ」と思うこともあるので、本文の方は別の解決法が必要そうです。

[faithandbrave]

不適格 (ill-formed) は規格用語でユーザーにはなじみがなさそうなので、できるだけ「コンパイルエラー」と書くようにしてます。

未規定、未定義動作、処理系定義は用語としてあってもよいと思います。

<algorithm>のページに「狭義の弱順序」の解説があります。
https://cpprefjp.github.io/reference/algorithm.html#strict-weak-ordering
こういった、特定領域の用語 (ヘッダもしくはクラスレベルで解説できる用語) はこのままにして、C++の全体で使うような用語集を作ればよいでしょうか。

略語表は、私と @egtra さんの間で伝えるために、iostream関係のわかりにくい略語を、リファレンスを書く前の段階で調査するためにありました。なので、リファレンスに略語元を記載したら削除する予定でした。

[saki7]

背景の説明ありがとうございます。非常に助かります。

不適格 (ill-formed) は規格用語でユーザーにはなじみがなさそうなので、できるだけ「コンパイルエラー」と書くようにしてます。

のページに「狭義の弱順序」の解説があります。
https://cpprefjp.github.io/reference/algorithm.html#strict-weak-ordering
こういった、特定領域の用語 (ヘッダもしくはクラスレベルで解説できる用語) はこのままにして、C++の全体で使うような用語集を作ればよいでしょうか。

はい。イメージとして、「特定領域・特定の関数・特定のクラスなどに関係なくサイト全体で出てくる用語のうち、C++の標準規格と関係が深いもの」をまとめた単一解説記事を想像しています。

「不適格」は、GitHubの検索だと数件しか出ないのですが、Googleで全文検索すると40件くらい出て来ます。「未規定」に至っては120件以上出てきます。用語の使い方に関しては柔軟に対応すれば良いと思いますが、広範に渡るので、まとめページがあると心強いです。

[saki7]

略語表は、私と @egtra さんの間で伝えるために、iostream関係のわかりにくい略語を、リファレンスを書く前の段階で調査するためにありました。なので、リファレンスに略語元を記載したら削除する予定でした。

略語は、数が少なくても1か所に目録としてまとめることで価値が出るので、これも含めれば良いと思います。

訳語表は、ここに既にあるのですが、これも「スタイル」から分離して本Issueのページにまとめた方が良いと思います。 https://cpprefjp.github.io/working_style.html

[faithandbrave]

略語はサルベージするのに時間がかかると思いますが、追々でよければ・・・。
<cmath>とiostream関係がほとんどだとは思いますが、ほかは思い出せず…。
https://cpprefjp.github.io/reference/cmath/abs.html

[saki7]

@faithandbrave 最初から全てを解説しなくても良いので、初版はここのコメントで既に上がっているものだけで良いと思います。

新規に書き下ろす重要性がある用語は、僕が最初に挙げたものでほぼ網羅できていると思います。それ以外の用語については、移動できるなら移動だけします。

解説の本文を増補する必要がある場合は、気づいた人が１つずつ加筆します。

[yumetodo]

ところで @akinomyoga 氏による
C++er は“合法”だとか“違法”だとか言いたくて仕方がないけれど、結局どういう意味? それより適合・適格・○○動作・○○規則・診断不要いろいろの関係が謎 - Qiita
https://qiita.com/akinomyoga/items/592e5a3b8438a0c8556b
という記事があって大体これでいいんじゃないかという気がしてしまうんですがどうでしょう・・・？

[saki7]

cpprefjp ではコンテンツのライセンスを統一する必要があるため、画像を追加する際は cpprefjp/image というリポジトリに追加することになっています。画像の作者の方がcpprefjpのMemberの場合は個別に承認を頂けば良いと思いますが、そうでない場合は、新しく作った方が良いと思います。

画像ではなく本文についても同様です。外部サイトの作者の方に許諾を得て転載している例は今までも何回かはあります。

内容に関しては、僕はリンク先の記事は標準規格を非常に意識した書き方になっていると感じますが、本Issueで最初に書いた僕のイメージはもう少し柔らかいものです。なので、この記事よりはもう少し平易に書き下した方が良いと思います。

[saki7]

平易さに関して、僕は「中学一年生の教科書程度の平易さが望ましい」と書いていますが、これはCONTRIBUTINGに準じるので、”自分たちなりの言葉”で書かれているならそれで良いと思います。

[faithandbrave]

どこまで詳細に書くかは、ひとつの論点になりますね。用語ごとに1ページ使えるのであればどこまでも詳細に書ける、というものは多くありそうです。
WikipediaとかでもたとえばADLというのでひとつの記事になっています (@egtra さんが書いたらしい)。

解説にサンプルコードや図を付加したい、という意見があるなら、用語ごとに1ページということも考えられるのではないかと思います。
本サイトの方針は、「正確なものに不要なことはない」ということをCONTRIBUTING.mdに書いていますが、どこまでも詳細に書くことは問題なく、平易な説明が必要なら概要文章をそのような形にするといった工夫をすればよいですね。

[saki7]

Issueの投稿者として、管理者として、デザイナとしてどのような雰囲気が望ましいかという方針は一応示しましたが、最終的にはアキラさんが仰っているように初版の担当者の方の裁量で工夫して頂ければ充実すると思います。

[faithandbrave]

用語ごとに1ページ用意する場合は、用語ページの雛形が必要になります。
これまでの慣習では、たたき台となる記事をひとつ作り、それをレビューして必要な項目 (各見出し) を決めていって雛形を作ることになっていました。