Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

表記統一: 関数/メソッド #141

Closed
azu opened this issue Sep 12, 2016 · 4 comments · Fixed by #143
Closed

表記統一: 関数/メソッド #141

azu opened this issue Sep 12, 2016 · 4 comments · Fixed by #143

Comments

@azu
Copy link
Collaborator

azu commented Sep 12, 2016

#110 #140 表示が決まったので、統一する。

正式名称の表記

静的メソッド

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

インスタンスメソッド

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

文中初回時の表記

静的メソッド

Array.fromメソッド

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

Array#forEachメソッド

文中の表記

静的メソッド

Array.fromメソッド

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

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

関数

  • fn関数
  • fn()

音声読み上げ的に問題がありそうなため

textlintをかけるところは書く

@azu azu changed the title 表記統一: メソッド 表記統一: 関数/メソッド Sep 12, 2016
@azu
Copy link
Collaborator Author

azu commented Sep 13, 2016

fn() 表記を調べたらこんな感じだった。 /cc @laco0416

preset-js-function/no-function-paren: `console.log()` should be written `console.log`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/read-eval-print/README.md:48:5
                v
    47. また、JavaScriptの開発環境は高機能化が進んでいるため、デバッガーなどが用意されていることが多く、
    48. コードに`console.log()`と書かなくても値を見ることもできるようになっています。
    49. 
                ^

preset-js-function/no-function-paren: `Symbol()` should be written `Symbol`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/data-type/README.md:20:21
                                  v
    19.     - null: 値が存在しないnull値を意味するデータ型
    20.     - シンボル(Symbol): `Symbol()`で作られたインスタンスは一意で不変な値となる
    21. - オブジェクト(Object)
                                  ^

preset-js-function/no-function-paren: `関数名()` should be written `関数名`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/function-method/README.md:46:9
                        v
    45. 
    46. 宣言した関数は、`関数名()`と書くことで呼び出すことができます。
    47. 
                        ^

preset-js-function/no-function-paren: `オブジェクト.メソッド名()` should be written `オブジェクト.メソッド名`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/function-method/README.md:289:24
                                                       v
    288. 
    289. メソッドを呼び出す場合は、関数呼び出しと同様に`オブジェクト.メソッド名()`のように呼び出します。
    290. 
                                                       ^

preset-js-function/no-function-paren: `Object.keys()` should be written `Object.keys`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/loop/README.md:282:24
                                                       v
    281. 
    282. 安全にオブジェクトのプロパティを列挙するには、`Object.keys()`、`Object.values()`、`Object.entries()`などのメソッドが利用できます。
    283. 
                                                       ^

preset-js-function/no-function-paren: `Object.values()` should be written `Object.values`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/loop/README.md:282:40
                                                                        v
    281. 
    282. 安全にオブジェクトのプロパティを列挙するには、`Object.keys()`、`Object.values()`、`Object.entries()`などのメソッドが利用できます。
    283. 
                                                                        ^

preset-js-function/no-function-paren: `Object.entries()` should be written `Object.entries`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/loop/README.md:282:58
                                                                                           v
    281. 
    282. 安全にオブジェクトのプロパティを列挙するには、`Object.keys()`、`Object.values()`、`Object.entries()`などのメソッドが利用できます。
    283. 
                                                                                           ^

preset-js-function/no-function-paren: `Object.keys()` should be written `Object.keys`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/loop/README.md:285:1
         v
    284. 先ほどの例である、オブジェクトのキーと値を列挙するコードはfor...in文を使わずに書くことができます。
    285. `Object.keys()`は`object`自身がもつ列挙可能なプロパティ名の配列を返します。
    286. そのためfor...in文とは違い、親オブジェクトのプロパティは列挙されません。
         ^

preset-js-function/no-function-paren: `JSON.stringify()` should be written `JSON.stringify`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/implicit-coercion/README.md:215:26
                                               v
    214. これは、オブジェクトに対しては別の方法があるためです。
    215. 配列には`Array#join`、オブジェクトには`JSON.stringify()`などより柔軟な文字列化をする方法があります。
    216. そのため、`String`コンストラクタ関数での変換は、あくまでプリミティブ型に対してのみに留めるべきです。
                                               ^

preset-js-function/no-function-paren: `new Promise()` should be written `new Promise`.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/ajaxapp/promise/README.md:70:44
                                                                                    v
    69. 
    70. コールバック関数を使う形式のAPIをPromiseに置き換えるのは、次のコードのように`new Promise()`を用いるのが一般的です。
    71. Promiseのコンストラクタには、`resolve`と`reject`の2つの関数オブジェクトを引数とする関数を渡します。
                                                                                    ^

✖ 10 problems (10 errors, 0 warnings)

@lacolaco
Copy link
Collaborator

これらは機械的には判別できなさそう

2016/09/13 午前10:05 "azu" notifications@github.com:

fn() 表記を調べたらこんな感じだった。 /cc @laco0416 https://github.com/laco0416

preset-js-function/no-function-paren: console.log() should be written console.log.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/read-eval-print/README.md:48:5
v
47. また、JavaScriptの開発環境は高機能化が進んでいるため、デバッガーなどが用意されていることが多く、
48. コードにconsole.log()と書かなくても値を見ることもできるようになっています。
49.
^

preset-js-function/no-function-paren: Symbol() should be written Symbol.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/data-type/README.md:20:21
v
19. - null: 値が存在しないnull値を意味するデータ型
20. - シンボル(Symbol): Symbol()で作られたインスタンスは一意で不変な値となる
21. - オブジェクト(Object)
^

preset-js-function/no-function-paren: 関数名() should be written 関数名.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/function-method/README.md:46:9
v
45.
46. 宣言した関数は、関数名()と書くことで呼び出すことができます。
47.
^

preset-js-function/no-function-paren: オブジェクト.メソッド名() should be written オブジェクト.メソッド名.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/function-method/README.md:289:24
v
288.
289. メソッドを呼び出す場合は、関数呼び出しと同様にオブジェクト.メソッド名()のように呼び出します。
290.
^

preset-js-function/no-function-paren: Object.keys() should be written Object.keys.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/loop/README.md:282:24
v
281.
282. 安全にオブジェクトのプロパティを列挙するには、Object.keys()Object.values()Object.entries()などのメソッドが利用できます。
283.
^

preset-js-function/no-function-paren: Object.values() should be written Object.values.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/loop/README.md:282:40
v
281.
282. 安全にオブジェクトのプロパティを列挙するには、Object.keys()Object.values()Object.entries()などのメソッドが利用できます。
283.
^

preset-js-function/no-function-paren: Object.entries() should be written Object.entries.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/loop/README.md:282:58
v
281.
282. 安全にオブジェクトのプロパティを列挙するには、Object.keys()Object.values()Object.entries()などのメソッドが利用できます。
283.
^

preset-js-function/no-function-paren: Object.keys() should be written Object.keys.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/loop/README.md:285:1
v
284. 先ほどの例である、オブジェクトのキーと値を列挙するコードはfor...in文を使わずに書くことができます。
285. Object.keys()object自身がもつ列挙可能なプロパティ名の配列を返します。
286. そのためfor...in文とは違い、親オブジェクトのプロパティは列挙されません。
^

preset-js-function/no-function-paren: JSON.stringify() should be written JSON.stringify.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/basic/implicit-coercion/README.md:215:26
v
214. これは、オブジェクトに対しては別の方法があるためです。
215. 配列にはArray#join、オブジェクトにはJSON.stringify()などより柔軟な文字列化をする方法があります。
216. そのため、Stringコンストラクタ関数での変換は、あくまでプリミティブ型に対してのみに留めるべきです。
^

preset-js-function/no-function-paren: new Promise() should be written new Promise.
/Users/azu/.ghq/github.com/asciidwango/js-primer/source/ajaxapp/promise/README.md:70:44
v
69.
70. コールバック関数を使う形式のAPIをPromiseに置き換えるのは、次のコードのようにnew Promise()を用いるのが一般的です。
71. Promiseのコンストラクタには、resolverejectの2つの関数オブジェクトを引数とする関数を渡します。
^

✖ 10 problems (10 errors, 0 warnings)


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#141 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ABdVXBBWb_1F4fDtwh_KfiVC88zKU7Puks5qpfblgaJpZM4J6LGX
.

@azu
Copy link
Collaborator Author

azu commented Sep 13, 2016

  1. メソッドを呼び出す場合は、関数呼び出しと同様にオブジェクト.メソッド名()のように呼び出します。
  2. 宣言した関数は、関数名()と書くことで呼び出すことができます。

は例外なので無視するとして、後は一応代替表現ある感じかな。
なんとなく Symbol() だけ微妙感があるけど(コンストラクタではないし、関数?って感じの存在)

@azu
Copy link
Collaborator Author

azu commented May 18, 2017

これ改めて見ると、JavaScriptの関数は()で呼ぶとは限らないので、
関数名関数は正しいと言えそう。

タグ付きテンプレートリテラルのタグ関数は タグ関数`テンプレート` で関数を呼び出すので、()で呼び出すのが関数とは言えない感じ。

From #227

テンプレートリテラル周りの用語整理

Name Code
タグ関数(tag function) String.raw`template`
タグ付きテンプレート(Tagged Templates) String.raw`template`
テンプレートリテラル(Template Literals) `template`
テンプレート文字列(TemplateStrings) `template` (`の中の文字列)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants