cvs: peardoc /ja/package/php/php-codesniffer advanced-usage.xml config-options.xml usage.xml
[email protected] ("TAKAGI Masahiro")
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <cvstakagi1196153987@cvsserver> |
takagi Tue Nov 27 08:59:47 2007 UTC
Modified files:
/peardoc/ja/package/php/php-codesniffer usage.xml
config-options.xml
advanced-usage.xml
Log:
sync with en.
http://cvs.php.net/viewvc.cgi/peardoc/ja/package/php/php-codesniffer/usage.xml?r1=1.8&r2=1.9&diff_format=u
Index: peardoc/ja/package/php/php-codesniffer/usage.xml
diff -u peardoc/ja/package/php/php-codesniffer/usage.xml:1.8 peardoc/ja/package/php/php-codesniffer/usage.xml:1.9
--- peardoc/ja/package/php/php-codesniffer/usage.xml:1.8 Fri Nov 9 22:43:33 2007
+++ peardoc/ja/package/php/php-codesniffer/usage.xml Tue Nov 27 08:59:47 2007
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.8 $ -->
-<!-- EN-Revision: 1.9 Maintainer: takagi Status: ready -->
+<!-- $Revision: 1.9 $ -->
+<!-- EN-Revision: 1.10 Maintainer: takagi Status: ready -->
<refentry id="package.php.php-codesniffer.usage">
<refnamediv>
<refname>使用法</refname>
@@ -21,7 +21,7 @@
Usage: phpcs [-nwlvi] [--report=<report>] [--standard=<standard>]
[--config-set key value] [--config-delete key] [--config-show]
[--generator=<generator>] [--extensions=<extensions>]
- [--ignore=<patterns>] <file> ...
+ [--ignore=<patterns>] [--tab-width=<width>] <file> ...
-n Do not print warnings
-w Print both warnings and errors (on by default)
-l Local directory only, no recursion
@@ -35,6 +35,7 @@
<patterns> A comma separated list of patterns that are used
to ignore directories and files
<standard> The name of the coding standard to use
+ <width> The number of spaces each tab represents
<generator> The name of a doc generator to use
(forces doc generation instead of checking)
<report> Print either the "full", "xml", "checkstyle",
http://cvs.php.net/viewvc.cgi/peardoc/ja/package/php/php-codesniffer/config-options.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/ja/package/php/php-codesniffer/config-options.xml
diff -u peardoc/ja/package/php/php-codesniffer/config-options.xml:1.2 peardoc/ja/package/php/php-codesniffer/config-options.xml:1.3
--- peardoc/ja/package/php/php-codesniffer/config-options.xml:1.2 Fri Nov 9 22:43:33 2007
+++ peardoc/ja/package/php/php-codesniffer/config-options.xml Tue Nov 27 08:59:47 2007
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
-<!-- EN-Revision: 1.2 Maintainer: takagi Status: ready -->
+<!-- $Revision: 1.3 $ -->
+<!-- EN-Revision: 1.3 Maintainer: takagi Status: ready -->
<refentry id="package.php.php-codesniffer.config-options">
<refnamediv>
<refname>設定オプション</refname>
@@ -59,6 +59,42 @@
</note>
</refsect2>
+ <refsect2 id="package.php.php-codesniffer.config-options.php-codesniffer.tab-width">
+ <title>デフォルトのタブ幅の設定</title>
+ <para>
+ デフォルトでは、PHP_CodeSniffer はチェックするファイルのタブをスペースに変換しません。
+ タブ幅を指定すると、PHP_CodeSniffer がタブをスペースに置き換えるようになります。
+ デフォルトでタブからスペースへの置き換えを行うよう PHP_CodeSniffer に指定するには、
+ 設定オプション <literal>tab_width</literal> を指定します。
+ </para>
+ <example>
+ <title>デフォルトのタブ幅を 4 に設定する</title>
+ <screen>
+ <userinput>
+<![CDATA[
+$ phpcs --config-set tab_width 4
+]]>
+ </userinput>
+ </screen>
+ </example>
+ <note>
+ <simpara>
+ タブ幅をデフォルトで設定している際に特定の実行時だけタブからスペースへの置き換えを無効にするには、
+ タブ幅をゼロに指定します。
+ </simpara>
+ <example>
+ <title>タブからスペースへの変換を無効にする</title>
+ <screen>
+ <userinput>
+<![CDATA[
+$ phpcs --tab-width=0 /path/to/code
+]]>
+ </userinput>
+ </screen>
+ </example>
+ </note>
+ </refsect2>
+
</refsect1>
http://cvs.php.net/viewvc.cgi/peardoc/ja/package/php/php-codesniffer/advanced-usage.xml?r1=1.5&r2=1.6&diff_format=u
Index: peardoc/ja/package/php/php-codesniffer/advanced-usage.xml
diff -u peardoc/ja/package/php/php-codesniffer/advanced-usage.xml:1.5 peardoc/ja/package/php/php-codesniffer/advanced-usage.xml:1.6
--- peardoc/ja/package/php/php-codesniffer/advanced-usage.xml:1.5 Fri Nov 9 22:43:33 2007
+++ peardoc/ja/package/php/php-codesniffer/advanced-usage.xml Tue Nov 27 08:59:47 2007
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.5 $ -->
-<!-- EN-Revision: 1.5 Maintainer: takagi Status: ready -->
+<!-- $Revision: 1.6 $ -->
+<!-- EN-Revision: 1.6 Maintainer: takagi Status: ready -->
<refentry id="package.php.php-codesniffer.advanced-usage">
<refnamediv>
<refname>高度な使用法</refname>
@@ -103,6 +103,34 @@
</refsect1>
+ <refsect1 id="package.php.php-codesniffer.advanced-usage.replace-tabs-spaces">
+ <title>タブのスペースへの置き換え</title>
+ <para>
+ PHP_CodeSniffer 用に書かれた sniff のほとんどは、
+ 字下げや位置調整にタブを使用することをサポートしていません。
+ 自分で sniff を作成する際にはスペースではなくタブをチェックするようにすることもできますが、
+ ファイルをチェックする前に、タブをスペースに変換させるよう
+ PHP_CodeSniffer に指定することもできます。
+ こうすることで、スペースを想定している既存の sniff でタブを含むファイルを使用することができます。
+ </para>
+ <para>
+ 次の例では、ファイルをチェックする前に PHP_CodeSniffer
+ がすべてのタブを 1 個から 4 個のスペースに置き換えます。
+ スペースの量は、そのタブが字下げをするカラムによって決まります。
+ </para>
+ <example>
+ <title>タブからスペースへの変換</title>
+ <screen>
+ <userinput>
+<![CDATA[
+$ phpcs --tab-width=4 /path/to/code
+]]>
+ </userinput>
+ </screen>
+ </example>
+ </refsect1>
+
+
<refsect1 id="package.php.php-codesniffer.advanced-usage.xml-report">
<title>XML でのレポートの表示</title>
<para>