Google JavaScript スタイルガイド - 日本語訳
http://w.atwiki.jp/aias-jsstyleguide2/
Google JavaScript スタイルガイド - 日本語訳
ja
2013-08-11T12:42:42+09:00
1376192562
-
JavaScriptのデータ型
https://w.atwiki.jp/aias-jsstyleguide2/pages/17.html
#include_js(http://www38.atwiki.jp/aias-jsstyleguide2/?cmd=upload&act=open&page=%E3%83%88%E3%83%83%E3%83%97%E3%83%9A%E3%83%BC%E3%82%B8&file=goog_style_guide.js)
#divclass(page_title){
&this_page()
}
JSDocへのデータ型の記述は、できるだけ具体的かつ正確に行ってください。我々のサポートする型のスタイルは&blanklink(EcmaScript 4 仕様){http://wiki.ecmascript.org/doku.php?id=spec:spec}に基づいています。
*** &aname(js_type_language,option=nolink){JavaScriptの型言語}
ES4の提案にはJavaScriptのデータ型を定義する言語が含まれていました。この言語をJSDoc内で用い、関数パラメータや戻り値の型を表現します。
ES4提案の進展に伴い、その型言語も変化しています。Compilerは古い構文もサポートしていますが、現在それらは非推奨となっています。
|構文名|構文|説明|非推奨の構文|h
|Primitive Type|JavaScriptに含まれる5種類のプリミティブ型: &spanclass(keywd){{null}}, &spanclass(keywd){{undefined}}, &spanclass(keywd){{boolean}}, &spanclass(keywd){{number}}, &spanclass(keywd){{string}}|シンプルな型名称||
|Instance Type|&spanclass(keywd2){{Object}}&br()Objectのインスタンスもしくはnull&br()&br()&spanclass(keywd2){{Function}}&br()Functonのインスタンスもしくはnull&br()&br()&spancla
2013-08-11T12:42:42+09:00
1376192562
-
Closure Linterの使い方
https://w.atwiki.jp/aias-jsstyleguide2/pages/16.html
#divclass(page_title){
&this_page()
}
- このページは &blanklink(){http://code.google.com/intl/ja/closure/utilities/docs/linter_howto.html} の日本語訳です。
- &blanklink(Closure Linter){http://code.google.com/intl/ja/closure/utilities/index.html}はJavaScriptのコードスタイルがGoogleのスタイルガイドに適合しているかをチェックするツールで、Google自身が提供しています。またエラーを警告するだけでなく、エラー箇所を自動的に修正してくれる機能も持っています。
このドキュメントは Closure Linter のインストールと利用の仕方を解説するものです。
** Closure Linter のインストール
Closure Linter のインストールには、Python の&spanclass(keywd){easy_install}ユーティリティを使ってください。
*** Linux
LinuxにClosure Linter をインストールするには、以下のコマンドを実行してください。
#blockquote(){{$ cd /tmp
/tmp$ sudo easy_install &nolink(http://closure-linter.googlecode.com/files/closure_linter-latest.tar.gz)
}}
*** Mac OS X
Mac OS XにClosure Linter をインストールするには、以下のコマンドを実行してください。
#blockquote(){{$ sudo easy_install &nolink(http://closure-linter.googlecode.com/files/closure_linter-latest.tar.gz)
}}
*** Windows
Windowsに Closure Linter をインストールするには:
+ &blanklink(Windows版Python){http://www.python
2011-08-28T21:48:29+09:00
1314535709
-
JavaScriptのスタイルに関するルール
https://w.atwiki.jp/aias-jsstyleguide2/pages/15.html
#include_js(http://www38.atwiki.jp/aias-jsstyleguide2/?cmd=upload&act=open&page=%E3%83%88%E3%83%83%E3%83%97%E3%83%9A%E3%83%BC%E3%82%B8&file=goog_style_guide.js)
#divclass(page_title){
&this_page()
}
- 各項目の左側にある三角ボタン&html(<img src="http://www38.atwiki.jp/aias-jsstyleguide2/?cmd=upload&act=open&page=%E3%83%88%E3%83%83%E3%83%97%E3%83%9A%E3%83%BC%E3%82%B8&file=tri_down.gif" />)で、詳細情報の表示・非表示を切り替えられます。また下のボタンを使うと全項目を一度に変更することができます。
#divid(showhide_all){
&html(<div id="showhide_all_btn" class="show_dtl" ></div>)全て切り替える}
** &aname(naming,option=nolink){命名規則}
&html(<div id="shbtn_naming" class="show_dtl" ></div>)原則として、関数は&spanclass(keywd){functionNamesLikeThis}、変数は&spanclass(keywd){variableNamesLikeThis}、クラスは&spanclass(keywd){ClassNamesLikeThis}、列挙型は&spanclass(keywd){EnumNamesLikeThis}、メソッドは&spanclass(keywd){methodNamesLikeThis}、定数は&spanclass(keywd){CONSTANT_VALUES_LIKE_THIS}、名前空間は&spanclass(keywd){foo.namespaceNamesLikeThis.bar}、ファイルは&spanclass(keywd){filenameslikethis.js}のように、それぞれ命名
2015-02-17T14:00:48+09:00
1424149248
-
JSDocコメント
https://w.atwiki.jp/aias-jsstyleguide2/pages/14.html
#divclass(page_title){
&this_page()
}
我々は&blanklink(C++ style for comments){http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Comments}の考え方に従います。
全てのファイル、クラス、メソッド、プロパティに&blanklink(JSDoc){http://code.google.com/p/jsdoc-toolkit/}コメントが、適切な&link_anchor(jsdoc_tag_reference){タグ}と&link_anchor(js_type_language,pageid=17){データ型}を伴って記されるべきです。また名前から明白に判断できる場合を除き、プロパティ、メソッド、メソッドの引数、メソッドの戻り値を説明する文章が含まれているべきです。
インラインのコメントには&spanclass(keywd){//}の方を使います。
完全文(Complete sentence)で書くことを推奨しますが、必須ではありません。完全文を使う場合は適切に大文字で開始し、句読点で終わらせましょう。
*** &anchor(comment_syntax,option=nolink){コメントの構文}
JSDocの構文は&blanklink(JavaDoc){http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html}を元にしています。沢山のツールがJSDocコメントから取り出したメタデータを使ってコードの検証や最適化を行なっているため、コメントは適切に整形されたものでなければなりません。
#blockquote(){{{#divclass(comment){{
/**
 (1)* JSDocコメントはスラッシュと2つのアスタリスクから始めます。
 (1)* インラインタグは &spanclass(doctag){{@code this}} のように波括弧で囲みます。
 (1)* &spanclass(doctag){@des
2013-10-16T00:16:29+09:00
1381850189
-
JavaScriptの言語仕様に関するルール
https://w.atwiki.jp/aias-jsstyleguide2/pages/13.html
#include_js(http://cdn38.atwikiimg.com/aias-jsstyleguide2/?cmd=upload&act=open&page=%E3%83%88%E3%83%83%E3%83%97%E3%83%9A%E3%83%BC%E3%82%B8&file=goog_style_guide.js)
#divclass(page_title){
&this_page()
}
- 各項目の左側にある三角ボタン&html(<img src="http://www38.atwiki.jp/aias-jsstyleguide2/?cmd=upload&act=open&page=%E3%83%88%E3%83%83%E3%83%97%E3%83%9A%E3%83%BC%E3%82%B8&file=tri_down.gif" />)で、詳細情報の表示・非表示を切り替えられます。また下のボタンを使うと全項目を一度に変更することができます。
#divid(showhide_all){
&html(<div id="showhide_all_btn" class="show_dtl" ></div>)全て切り替える}
** &aname(var,option=nolink){var}
&html(<div id="shbtn_var" class="show_dtl" ></div>)常に、&spanclass(keywd){var}と共に変数を宣言します。
#divid(dtl_var){{{
#divclass(dtl){{
&spanclass(keywd2){var}の指定がない場合、変数はグローバルコンテキストに置かれ、既存の値を上書きする可能性があります。またもし宣言そのものがなければ、その変数のスコープがどこにあるのか分かりにくくなります(その変数はローカルスコープと同じように、DocumentやWindowの中に存在していてもよいのです)。従って常に&spanclass(keywd){var}と共に変数を宣言してください。
}}
}}}
** &aname(constants,option=nolink){定数}
&html(<div id="shbtn_constants" class="show_dt
2015-02-17T13:34:02+09:00
1424147642
-
メニュー
https://w.atwiki.jp/aias-jsstyleguide2/pages/2.html
***サイト内検索
#search2(or,submit=検索, title=,size=60,ignore=own)
----
**コンテンツ
-&link2(トップページ)
#divclass(space){}
-&link(言語仕様に関するルール){JavaScriptの言語仕様に関するルール}
--&link_anchor(var,pageid=13){var}
--&link_anchor(constants,pageid=13){定数}
--&link_anchor(semicolons,pageid=13){セミコロン}
--&link_anchor(nested_functions,pageid=13){ネストされた関数}
--&link_anchor(function_declarations_within_blocks,pageid=13){ブロック内での関数宣言}
--&link_anchor(exceptions,pageid=13){例外}
--&link_anchor(custom_exceptions,pageid=13){独自の例外}
--&link_anchor(standards_features,pageid=13){標準機能}
--&link_anchor(wrapper_objects_for_primitive_types,pageid=13){プリミティブ型のラッパーオブジェクト}
--&link_anchor(multi_level_prototype_hierarchies,pageid=13){多段階のプロトタイプ階層}
--&link_anchor(method_and_property_definitions,pageid=13){メソッドとプロパティの定義}
--&link_anchor(delete,pageid=13){delete}
--&link_anchor(closures,pageid=13){クロージャ}
--&link_anchor(eval,pageid=13){eval()}
--&link_anchor(with,pageid=13){with()}
--&link_anchor(this,pageid=13){this}
--&link
2013-10-14T21:39:29+09:00
1381754369
-
トップページ
https://w.atwiki.jp/aias-jsstyleguide2/pages/1.html
-このサイトは &blanklink(Google JavaScript Style Guide){http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml}(Revision 2.93) を私的に日本語訳したものです。
-この翻訳の内容について、翻訳者は一切の責任を負いません。ご利用は自己責任でお願いします。
-以下のコーディングルールは、最終的にコードを&blanklink(Closure Compiler){http://code.google.com/p/closure-compiler/}にかけて完成させることが暗黙の前提となっている点に注意してください。Closure CompilerはGoogle自身が提供しているJavaScript圧縮・最適化ツールです。(こちらの&blanklink(日本語の解説){http://www37.atwiki.jp/aias-closurecompiler/}も参考にしてみてください。)
-JavaScriptコードがこのスタイルガイドに適合しているかどうかを検証する、&blanklink(Clisure Linter){http://code.google.com/intl/ja/closure/utilities/index.html}というツールがGoogleから提供されています。使い方は&link(こちら){Closure Linterの使い方}を参照してください。
#divclass(author){{
2.93 版
Aaron Whyte
Bob Jervis
Dan Pupius
Erik Arvidsson
Fritz Schneider
Robby Walker
}}
** 目次
#divclass(content_lite){{
- &link2(JavaScriptの言語仕様に関するルール)
#divclass(content_lite_list){
|&link_anchor(var,pageid=13){var}|&link_anchor(constants,pageid=13){定数}|&link_anchor(semicolons,pageid=13){セミコロン
2015-02-17T13:02:02+09:00
1424145722