Kosei Kitahara avatar Kosei Kitahara committed 1aca13f

Update sentence

Comments (0)

Files changed (1)

     タイプミス、未初期化変数の利用などの単純ミスを発見できます。
 
 欠点:
-    `pychecker` は完璧ではありません。利用するために、a) コードを書き b) 警告の無効化 c) 改修する もしくは d) 無視する 等が必要になることがあります。
+    `pychecker` は完璧ではありません。
+    利用するために、a) コードを書き b) 警告の無効化 c) 改修する もしくは d) 無視する 等が必要になることがあります。
 
 結論:
     コードに対し、 `pychecker` を必ず実行します。
 
     `x` がパッケージの接頭辞、 `y` が接頭辞でないモジュール名の場合は `from x import y` を利用する。
 
-    モジュール `y` を 2 つインポートする必要がある場合や、
+    モジュール `y` を 2 つインポートする場合や、
     `y` が長すぎる場合は `from x import y as z` を利用する。
 
     例えば、 sound.effects.echo というモジュールの場合は以下のようにインポートする::
     例えば、すべて実行した後にエラーコードを返すのではなく、ネストした関数からワンステップで戻せます。
 
 欠点:
-    処理のコントロールが複雑になるので注意する必要があります。
+    処理のコントロールが複雑になるので注意が必要です。
     ライブラリーを呼び出す際の、エラーを発見しにくくしてしまう可能性があります。
 
 結論:
     計算が軽量になります。
     クラスのインターフェースを維持するための Pythonic な考え方です。
     パフォーマンスに関して、変数への直接アクセスが理にかなっている場合は、
-    通常のアクセサメソッドをプロパティーへ置き換える必要があります。
+    通常のアクセサメソッドをプロパティーへ置き換えます。
     これはアクセサメソッドがインターフェースを変更することなく機能を追加できるようにします。
 
 欠点:
       しかし、他の値 (`0`, `[]` 等) もブール値コンテキスト内で false の可能性があります。
     * ブール変数は `==` を使って `False` と比較してはいけません。
       `if not x:` を代用します。
-      もし、 `False` と `None` を区別する必要がある場合は、
+      もし、 `False` と `None` を区別する場合は、
       `if not x and x is not None:` のように評価をつなげます。
     * シーケンス (文字列、配列、タプル) の場合、
       空のシーケンスも確実に false とするため、
 モジュール
 ''''''''''
 
-すべてのファイルは以下のアイテムを確実に含む必要があります。
+すべてのファイルは以下の事項を含めます。
 
 * 著作権表記 (たとえば、 `Copyright 2008 Google Inc.`)
 * ライセンス定型文。プロジェクトが利用するライセンスの適切な定型文 (例えば、Apache 2.0、BSD、LGPL、GPL)
 ドキュメンテーション文字列は、コードを 1 行も見ることなく、
 その関数を呼び出すための十分な情報を記載します。
 ドキュメンテーション文字列は、関数を呼び出すための構文とそのセマンティクスではなく、その実装を記述します。
-トリッキーなコードには、ドキュメンテーション文字列よりもコードに添ったコメントの方が適しています。
+複雑なコードには、ドキュメンテーション文字列よりもコードに添ったコメントの方が適しています。
 
 特定の関数は、以下のように特定のセクションで文書化します。
 各セクションはコロンで終わる見出し行で始まります。
 クラス
 ''''''
 
-クラスには、クラス定義の直下にそのクラスを説明するドキュメンテーション文字列を記載する必要があります。
+クラスには、クラス定義の直下にそのクラスを説明するドキュメンテーション文字列を記載ます。
 クラスがパブリックの属性を有している場合は、関数の変数部分と同様に、 Attributes にドキュメンテーションを記述します。 ::
 
     class SampleClass(object):
 '''''''''''''''''''''''
 
 最後にコメントを記述するのは、コードの複雑な箇所です。
-もし `コードレビュー`_ 等で説明する必要がある場合は、注釈を入れておく必要があります。
+もし `コードレビュー`_ 等で説明する必要がある場合は、注釈を入れます。
 複雑な演算の前に、2 から 3 行のコメントを記載します。
-わかりにくい演算は行の終わりにコメントを記載します::
+わかりにくい演算は行の終わりにコメントを記載します::
 
     # We use a weighted dictionary search to find out where i is in
     # the array.  We extrapolate position based on the largest num
 
     if i & (i-1) == 0:        # true iff i is a power of 2
 
-可読性を向上するため、コメントはコードから少なくとも 2 つ空白を開ける必要があります。
+可読性を向上するため、コメントはコードから少なくとも 2 つ空白を開けます。
 
-また、決してコードを記載してはいけません。コードを読んでいる人は Python に精通していると仮定します::
+また、決してコードを記載してはいけません。コードを読んでいる人は Python に精通していると仮定します::
 
     # BAD COMMENT: Now go through the b array and make sure whenever i occurs
     # the next element is i+1
 ``````
 
 パラメータがすべて文字列の場合は、その文字列のフォーマットを指定するために `%` 演算子を利用します。
-しかし、 `+` か `%` のどちらが適切かを判断する必要があります。 ::
+しかし、 `+` か `%` のどちらが適切かを判断します::
 
     # No:
     x = '%s%s' % (a, b)  # use + in this case
 短期的で解決すべきこと、条件を満たしてはいるがベストではない場合などに、
 コードに一時的な `TODO` コメントを利用します。
 
-TODO は頭に `TODO` を含む必要があり、続いて括弧内に名前やメールアドレス、もしくはその他の識別情報を記載します。
+TODO は `TODO` から開始し、続いて括弧内に名前やメールアドレス、もしくはその他の識別情報を記載します。
 オプションでコロンをつけます。
 コメントで今後どうするかを解説します。
 主な目的は、共通の `TODO` フォーマットにより (検討すべきより詳細な情報を持っている) コメントの記載者が検索できるようにすることです。
 * サードパーティーのインポート
 * アプリケーション固有のインポート
 
-各グループの範囲内で、インポートは辞書記載順、大文字小文字は無視、すべてのパッケージパスを記載する必要があります。 ::
+各グループの範囲内で、インポートは辞書記載順、大文字小文字は無視、すべてのパッケージパスを記載ます。 ::
 
     import foo
     from foo import bar
 インポートが必要なスクリプトでも、
 単純に `main()` 関数で実行する場合でも、
 スクリプトの主要な機能の実行に差異があってはいけません。
-メイン 関数は `main()` 関数である必要があります。
+メイン 関数は `main()` 関数です。
 
-Python においては、 `pychecker` 、 `pydoc` と単体テストはモジュールがインポート可能であることが必要です
+Python においては、 `pychecker` 、 `pydoc` と単体テストはモジュールがインポート可能でなければなりません
 モジュールのインポート時にメイン 関数が実行されないように、
-メインプログラムを実行する前に `if __name__ == '__main__'` で常にチェックする必要があります。 ::
+メインプログラムを実行する前に `if __name__ == '__main__'` で常にチェックます。 ::
 
     def main():
         ...
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.