クラスメソッド/インスタンスメソッドの表記

[azu]

from #49 (comment)

forEachメソッド
Array#forEach
array.forEach
Array.prototype.forEach

どれかの表記にまとめたい感じがする。
#80 (comment)

メソッドとかの表記について決めたい。

• 正式名称(タイトルとか)の書き方
• 文中でも初回時の書き方(殆ど気にしなくて良さそう)
• 文中に繰り返し出てくる時の書き方

で使い分けるのもありそう。

次のものについてそれぞれについて考える。

• Array.prototype.forEach
• Array.from
• Number.MAX_VALUE

## 正式名称の表記
### クラスメソッド
### インスタンス(prototype)メソッド
## 文中初回時の表記
### クラスメソッド
### インスタンス(prototype)メソッド
## 文中の表記
### クラスメソッド
### インスタンス(prototype)メソッド

[azu]

自分の意見的には次のような感じ

正式名称の表記

クラスメソッド

Array.fromメソッド

インスタンス(prototype)メソッド

Array.prototype.forEachメソッド

文中初回時の表記

クラスメソッド

Array.fromメソッド

インスタンス(prototype)メソッド

Array#forEachメソッド

文中の表記

クラスメソッド

Array.fromメソッド

インスタンス(prototype)メソッド

Array#forEachメソッド または コンテキスト的に理解できるならforEachメソッド

JavaScriptのビルトインでは、クラスメソッドとインスタンスメソッドで同じ名前を持っているものはいない?
なので、片方しか出てきてなく、何度も繰り返している場合は forEachメソッド という表記も問題ないと考えている。

---

メソッドとつけてるのは、プロパティとの対比が目的。
Number.MAX_VALUEプロパティ
Array#lengthプロパティ もありだが多くの場合 lengthプロパティとしたい。

末尾に、 オブジェクト、関数、メソッド、プロパティ を付けることで区別するという方向。
(メソッドはクラスメソッドとインスタンスメソッドがあって分かりにくいので、表記法として#を使うことを許容する)

参考

• 説明文書でのメソッド・変数の書き表し方 - Java | 【OKWAVE】
• 「クラス名::関数名()」という記述方法 • C言語交流フォーラム　～ mixC++ ～
• swift - Swiftのメソッドの自然言語文中での表記法 - スタック・オーバーフロー
• メソッド (計算機科学) - Wikipedia

[azu]

◯ 静的メソッド
✗ クラスメソッド

[azu]

fn() と書くか fn関数 と書くか

[azu]

関数/メソッドの表現には カッコ なしで書くで 決定

◯ fn関数
✗ fn()

[azu]

() ありだと音声読み上げしにくそう

[azu]

Array#forEachメソッド または コンテキスト的に理解できるならforEachメソッド

これでOK。
初回のみはちゃんと 親を書く

[azu]

文章中に fn() が出てくるのは禁止する?(fn関数と書けという話)
Lintできるかもしれない

[azu]

JavaScript本格入門では

• 静的メソッド
• 静的プロパティ
• インスタスメソッド
• インスタンスプロパティ

だった

[azu]

#141 最終型は

正式名称の表記

静的メソッド

• ○ 静的メソッド
• ○ Array.fromメソッド
• ✗ クラスメソッド

インスタンスメソッド

• ○ インスタンスメソッド
• ○ Array.prototype.forEachメソッド
• ✗ プロトタイプメソッド
• ✗ prototypeメソッド

文中初回時の表記

静的メソッド

Array.fromメソッド

インスタンス(prototype)メソッド

Array#forEachメソッド

文中の表記

静的メソッド

Array.fromメソッド

インスタンス(prototype)メソッド

Array#forEachメソッド または コンテキスト的に理解できるならforEachメソッド

関数

• ○ fn関数
• ✗ fn()