diff --git a/src/style-guide/README.md b/src/style-guide/README.md index a2242cf6..24d8f2b5 100644 --- a/src/style-guide/README.md +++ b/src/style-guide/README.md @@ -22,11 +22,11 @@ sidebar: auto ### 優先度 C: 推奨 -同じくらい良いオプションが複数ある場合、一貫性を確保するために任意の選択をすることができます。これらのルールでは、それぞれ許容可能なオプションを説明し、既定の選択を提案します。つまり、一貫性があり、正当な理由を持ち続ける限り、独自のコードベースで自由に異なる選択肢を作ることができます。ですが、正当な理由を必ず持つようにしてください!コミュニティの標準に合わせることで、あなたは: +同じくらい良いオプションが複数ある場合、一貫性を確保するために任意の選択をすることができます。これらのルールでは、それぞれ許容可能なオプションを説明し、既定の選択を提案します。つまり、一貫性があり、正当な理由を持ち続ける限り、独自のコードベースで自由に異なる選択肢を作ることができます。ですが、正当な理由を必ず持つようにしてください!コミュニティの標準に合わせることで、あなたは: -1. 直面するコミュニティのコードを容易に理解できるように脳を慣れさせます。 -2. ほとんどのコミュニティのコードサンプルを変更なしにコピーして貼り付ける事ができます。 -3. 少なくとも Vue に関しては、ほとんどの場合、新たな人材はあなたのコーディングスタイルよりも既に慣れ親しんだものを好みます。 +1. 直面するコミュニティのコードを容易に理解できるように脳を慣れさせます。 +2. ほとんどのコミュニティのコードサンプルを変更なしにコピーして貼り付ける事ができます。 +3. 少なくとも Vue に関しては、ほとんどの場合、新たな人材はあなたのコーディングスタイルよりも既に慣れ親しんだものを好みます。 ### 優先度 D: 使用注意 @@ -38,36 +38,35 @@ Vue のいくつかの機能は、レアケースまたは従来のコードベ **ルートの `App` コンポーネントや、Vue が提供する `` や `` のようなビルトインコンポーネントを除き、コンポーネント名は常に複数単語とするべきです。** -全ての HTML 要素は 1 単語なので、このルールを守ることで既に存在する HTML 要素や将来定義される HTML 要素との[衝突を防止することができます](http://w3c.github.io/webcomponents/spec/custom/#valid-custom-element-name)。 +全ての HTML 要素は 1 単語なので、このルールを守ることで既に存在する HTML 要素や将来定義される HTML 要素との [衝突を防止することができます](https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name)。

悪い例

-``` js +```js app.component('todo', { // ... }) ``` -``` js +```js export default { name: 'Todo', // ... } ``` -

良い例

-``` js +```js app.component('todo-item', { // ... }) ``` -``` js +```js export default { name: 'TodoItem', // ... @@ -82,7 +81,7 @@ export default { コミットされたコードでは、prop の定義は常に可能な限り詳細にすべきで、少なくともタイプの指定をする必要があります。 ::: details 詳細な説明 -詳細な[プロパティの定義](/guide/component-props.html#prop-validation) には 2 つの利点があります: +詳細な [プロパティの定義](/guide/component-props.html#プロパティのバリデーション) には 2 つの利点があります: - コンポーネントの API が明文化されるため、そのコンポーネントの使用方法が簡単に確認できます。 - 開発中、コンポーネントに対して誤った形式のプロパティが提供されると Vue は警告を通知するため、潜在的なエラー原因の検知に役立ちます。 @@ -91,7 +90,7 @@ export default {

悪い例

-``` js +```js // プロトタイピングの時に限り OK props: ['status'] ``` @@ -100,13 +99,13 @@ props: ['status']

良い例

-``` js +```js props: { status: String } ``` -``` js +```js // さらに良いです! props: { status: { @@ -130,12 +129,12 @@ props: { **`v-for` に対しては常に `key` を使用してください。** -サブツリーの内部コンポーネントの状態を維持するために、コンポーネントでの `v-for` には _常に_ `key` を付ける必要があります。ただし要素の場合であっても、アニメーションでの[オブジェクトの一貫性](https://bost.ocks.org/mike/constancy/)のように、予測可能な振る舞いを維持することをお勧めします。 +サブツリーの内部コンポーネントの状態を維持するために、コンポーネントでの `v-for` には _常に_ `key` を付ける必要があります。ただし要素の場合であっても、アニメーションでの [オブジェクトの一貫性](https://bost.ocks.org/mike/constancy/) のように、予測可能な振る舞いを維持することをお勧めします。 ::: details 詳細な説明 TODO リストを持っているとしましょう: -``` js +```js data() { return { todos: [ @@ -162,7 +161,7 @@ data() {

悪い例

-``` html +```html
  • {{ todo.text }} @@ -174,7 +173,7 @@ data() {

    良い例

    -``` html +```html
    • user.isActive) @@ -223,7 +222,7 @@ computed: { } ``` -``` html +```html
      • ` タグを使用して、 `
      • ` 要素をラップすることもできます: -``` html +```html