📄 astyle.html
字号:
<html>
<head>
<meta name="GENERATOR" content="Microsoft FrontPage 6.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<title>Artistic Style</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="EN">
<meta name="description"
content="Artistic Style is a source code indenter, source code formatter, and source code beautifier for the C, C++, C# and Java programming languages.">
<meta name="keywords"
content="artistic style, astyle, source code indenter, source code formatter, source code beautifier">
<style> <!--
h1 {color:#0000A0; text-align:center; font-style:italic; font-size:300%;}
h2 {color:#0000A0;}
h3 {color:#0000A0;}
h4 {font-size:105%;}
table {color:#0000A0; font-weight:bold;}
code {color:#0000A0;}
code.title {font-size:larger; font-weight:bold;}
pre {color:#0000A0; font-weight:bold;}
span.brace {color:red;}
--></style>
</head>
<body lang="EN">
<!-- CUT HERE FOR INSERTION INTO SOURCEFORGE DOC MANAGER -->
<!-- $Id: astyle.html,v 1.28 2004/07/20 04:26:28 devsolar Exp $ -->
<blockquote>
<h1>Artistic Style 1.21</h1>
<center>
<h2>A Free, Fast and Small Automatic Formatter<br>
for <em>C</em>, <em>C++</em>, <em>C#</em>, and <em>Java</em> Source Code
</h2>
</center>
<p> </p>
<p> </p>
<h2>General Information</h2>
<p><b>Line Endings</b><br>
Line endings in the formatted file will be the same as the input file. If
there are mixed line endings the most frequent occurrence will be used.</p>
<p><b>File Type</b><br>
Artistic Style will determine the file type from the file
extension. The extension ".java" indicates a Java file, and ".cs" indicates a C# file.
Everything else is a C or C++ file. If you are using a non-standard file
extension for Java or C#, use one of the <code>--mode=</code> options
described in "Formatting Options".</p>
<p><b>Quick Start</b><br>
If you have never used Artistic Style there are a couple of ways to
start. One is to run it with no options at all. This will format the file
with 4 spaces per indent and will leave the brackets unchanged. Another is
to use one of the predefined styles described in the "Predefined Style
Options". Select one with a bracket formatting style you like. Once you are
familiar with the options you can customize the format to your personal
preference.</p>
<p> </p>
<p>
</p>
<h2>Usage</h2>
<p>Artistic style is a console program that receives information from the
command line. The format of the command line is:</p>
<pre><strong>astyle [options] <em>SourceFile1.cpp SourceFile2.cpp SourceFile3.cpp</em> [ . . . ]</strong></pre>
<p>Or to save the file with a different name:</p>
<p></p>
<pre><strong>astyle [options] <font color="purple" size="4"><</font><em> OriginalSourceFile </em><font
color="purple" size="4">></font><em> BeautifiedSourceFile</em></strong>
</pre>
<p>The <font color="purple" size="5"><strong><</strong></font> and
<font color="purple" size="5"><strong>></strong></font> characters are used
to redirect the files into standard input and out of standard output - don't
forget them! </p>
<p>The block parens [ ] indicate that more than one option or more than one
filename can be entered. They are NOT actually included in the command. For
the options format see the following Options section.</p>
<p>With the first option, the newly indented file <strong>retains the
original file name</strong> , while a copy of the original file is created
with a<code><strong> .orig</strong></code> appended to the original file
name. (This can be set to a different string by the option <code>--suffix=</code>,
or suppressed altogether by the options <code>-n</code> or <code>
--suffix=none</code>). Thus, after indenting <code><em>SourceFile1.cpp</em></code>
as above, the indented result will be named <code><em>SourceFile1.cpp</em></code>,
while the original pre-indented file will be renamed to <code><em>
SourceFile1.cpp.orig</em></code>. </p>
<p>With the second option, the file is saved with a different name.
Therefore a copy is <strong>not</strong> created.</p>
<p><code><b>Wildcards</b></code> (such as "*.cpp"), can be used if the
project is compiled to include them. See the Installation Information
for instructions.</p>
<h2>Options File</h2>
<h4>A <font color="#0000a0">default options file</font> may be used to set
your favorite source style.</h4>
<ul>
<li>The command line options have precedence. If there is a conflict
between a command line option and an option in the default options file,
the command line option will be used. </li>
<li>Artistic Style looks for this file in the following locations (in
order):
<ol>
<li>the file indicated by the <strong>--options=</strong> command
line option; </li>
<li>the <b>file</b> and <b>directory</b> indicated by the environment variable <strong>
ARTISTIC_STYLE_OPTIONS</strong> (if it exists); </li>
<li>the file named <strong>.astylerc</strong> in the directory
pointed to by the <strong>HOME</strong> environment variable (e.g. "<strong>$HOME/.astylerc</strong>"
on Linux); </li>
<li>the file named <strong>astylerc</strong> in the directory
pointed to by the <strong>USERPROFILE</strong> environment variable
(e.g. "<strong>%USERPROFILE%\astylerc</strong>" on Windows). </li>
</ol>
</li>
<li>This option file lookup can be disabled by specifying <code>
--options=none</code> on the command line. </li>
<li>Options may be set apart by new-lines, tabs or spaces. </li>
<li>Long options <strong>in the options file</strong> may be written
<strong>without</strong> the preceding '<strong>--</strong>'. </li>
<li>Lines within the options file that begin with '<strong>#</strong>'
are considered <strong>line-comments</strong>. </li>
<li>Example of a default options file:
<blockquote>
<pre><strong><font color="#8080c0"># brackets should be attached to pre-bracket lines</font>
brackets=attach
<font color="#8080c0"># set 6 spaces per indent</font>
indent=spaces=6
<font color="#8080c0"># indent switch blocks</font>
indent-switches
<font color="#8080c0"># suffix of original files should be .pre</font>
suffix=.pre</strong>
</pre>
</blockquote>
</li>
</ul>
<p> </p>
<h2>Options </h2>
<p>Not specifying any option will result in C/C++ style indentation, no
change in bracket placement, 4 spaces per indent, and no formatting changes.</p>
<h4>Options may be written in two different ways:</h4>
<ul>
<li><strong>Long options:</strong><br>
These options start with '<strong><code>--</code></strong>', and <strong>
must be written one at a time.</strong><br>
(Example: '<code>--brackets=attach --indent=spaces=4</code>') </li>
<li><strong>Short Options:</strong><br>
These options start with a single '<strong><code>-</code></strong>', and
<strong>may be concatenated together</strong>.<br>
(Example: '<code>-bps4</code>' is the same as writing '<code>-b -p -s4</code>'.)
</li>
</ul>
<p> </p>
<hr>
<h3>Predefined Style Options</h3>
<p>Predefined Style options define the style by setting several other
options. If other options are also used, the placement of the
predefined style option in the command line is important. If the
predefined style option is placed first, the other options may override the
predefined style. If placed last, the predefined style will override
the other options.</p>
<p>For example the style <nobr>--style=ansi</nobr> sets the option <nobr>--brackets=break</nobr>
. If the command line specifies "<nobr>--style=ansi</nobr> <nobr>--brackets=attach</nobr>",
the brackets will be attached and the style will not be ansi style. If
the order on the command line is reversed to "<nobr>--brackets=attach</nobr>
<nobr>--style=ansi</nobr> ", the brackets will be broken (ansi style) and the attach
option will be ignored.</p>
<p>For the options set by each style check the parseOption function in astyle_main.cpp.</p>
<blockquote>
<p><code class="title">--style=ansi</code><br>
ANSI style formatting/indenting. Brackets are broken, indentation is 4
spaces. Namespaces, classes, and switches are NOT indented. </p>
<blockquote>
<pre>namespace foospace
<span class="brace">{</span>
int Foo()
<span class="brace">{</span>
if (isBar)
<span class="brace"> {</span>
bar();
return 1;
<span class="brace"> }</span>
else
return 0;
<span class="brace">}
}</span>
</pre>
</blockquote>
<p><br>
</p>
<p><code class="title">--style=gnu</code><br>
GNU style formatting/indenting. Brackets are broken, blocks are
indented, indentation is 2 spaces. Namespaces, classes, and switches are
NOT indented.</p>
<blockquote>
<pre>namespace foospace
<span class="brace"> {</span>
int Foo()
<span class="brace"> {</span>
if (isBar)
<span class="brace"> {</span>
bar();
return 1;
<span class="brace"> }</span>
else
return 0;
<span class="brace"> }
}</span>
</pre>
</blockquote>
<p><br>
</p>
<p><code class="title">--style=kr</code><br>
Kernighan&Ritchie style formatting/indenting. Brackets are attached,
indentation is 4 spaces. Namespaces, classes, and switches are NOT
indented.</p>
<blockquote>
<pre>namespace foospace <span class="brace">{</span>
int Foo() <span class="brace">{</span>
if (isBar) <span class="brace">{</span>
bar();
return 1;
<span class="brace"> }</span> else
return 0;
<span class="brace">}
}</span>
</pre>
</blockquote>
<p><br>
</p>
<p><code class="title">--style=linux</code><br>
Linux style formatting/indenting. All brackets are linux style,
indentation is 8 spaces. Namespaces, classes, and switches are NOT
indented.</p>
<blockquote>
<pre>namespace foospace
<span class="brace">{</span>
int Foo()
<span class="brace">{</span>
if (isBar) <span class="brace">{</span>
bar();
return 1;
<span class="brace"> }</span> else
return 0;
<span class="brace">}
}</span>
</pre>
</blockquote>
<p><br>
</p>
<p><code class="title">--style=java</code><br>
Java style formatting/indenting. Brackets are attached, indentation is 4
spaces. Switches are NOT indented.</p>
<blockquote>
<pre>class foospace <span class="brace">{</span>
int Foo() <span class="brace">{</span>
if (isBar) <span class="brace">{</span>
bar();
return 1;
<span class="brace"> }</span> else
return 0;
<span class="brace"> }
}</span>
</pre>
</blockquote>
</blockquote>
<hr>
<!-- * * * * * * * * * * * * Tab and Bracket Options * * * * * * * * * * * * -->
<h3>Tab and Bracket Options </h3>
<blockquote>
<p><code class="title">default indent option</code><br>
If no indentation option is set, the default option of <strong>4 spaces</strong>
will be used (e.g. <code>-s<font color="purple">4</font>
--indent=spaces=<font color="purple">4</font></code>). </p>
<p><code class="title">--indent=spaces=<font color="purple">#</font> /
-s<font color="purple">#</font></code><br>
Indent using <code><font color="purple">#</font></code> spaces per
indent (e.g. <code>-s<font color="purple">6</font></code> <code>
--indent=spaces=<font color="purple">6</font></code>).
<font color="purple">#</font> must be between <strong>2</strong> and
<strong>20</strong>. Not specifying <code><font color="purple">#</font></code>
will result in a default of <strong>4 spaces</strong> per indent. </p>
<p><code class="title">--indent=tab / --indent=tab=<font color="purple">#</font>
/ -t<font color="purple">#</font></code><br>
Indent using tab characters. Treat each tab as <code>
<font color="purple">#</font></code> spaces (e.g. <code>-t<font
color="purple">6</font></code> / <code>--indent=tab=<font
color="purple">6</font></code>). <font color="purple">#</font> must be
between <strong>2</strong> and <strong>20</strong>. If no <code>
<font color="purple">#</font></code> is set, treats tabs as <strong>4
spaces</strong>. </p>
<p><code class="title">--force-indent=tab=<font color="purple">#</font>
/ -T<font color="purple">#</font></code><br>
Indent using tab characters. Treat each tab as <code>
<font color="purple">#</font></code> spaces (e.g. <code>-T<font
color="purple">6</font></code> / <code>--force-indent=tab=<font
color="purple">6</font></code>). Uses tabs as indents where <code>
--indent=tab</code> prefers to use spaces, such as inside multi-line
statements. <font color="purple">#</font> must be between <strong>2</strong>
and <strong>20</strong>. If no <code><font color="purple">#</font></code>
is set, treats tabs as <strong>4 spaces</strong>. </p>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -