OLD | NEW |
1 title=Coding Style | 1 title=Coding Style |
2 | 2 |
3 | 3 |
4 <h2 id="precedence">{{s1 Precedence}}</h2> | 4 <h2 id="precedence">{{s1 Precedence}}</h2> |
5 | 5 |
6 <p>{{s2 The Adblock Plus coding style is based on others. Our rules (both genera
l and language specific) always overrule referenced style guides. The language s
pecific sections overrule the general section.}}</p> | 6 <p>{{s2 The Adblock Plus coding style is based on others. Our rules (both genera
l and language specific) always overrule referenced style guides. The language s
pecific sections overrule the general section.}}</p> |
7 | 7 |
8 <h2 id="consistency">{{s3 Consistency}}</h2> | 8 <h2 id="consistency">{{s3 Consistency}}</h2> |
9 | 9 |
10 <p>{{s4 Consistency is most important: Be consistent within functions, files, mo
dules and projects. Making existing code conform with this style guide is fine,
but it should happen in dedicated commits, preferably for a whole module or proj
ect at once.}}</p> | 10 <p>{{s4 Consistency is most important: Be consistent within functions, files, mo
dules and projects. Making existing code conform with this style guide is fine,
but it should happen in dedicated commits, preferably for a whole module or proj
ect at once.}}</p> |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
46 <li>{{html-css-optional-tag Don't omit optional HTML tags.}}</li> | 46 <li>{{html-css-optional-tag Don't omit optional HTML tags.}}</li> |
47 <li>{{html-css-hexadecimal CSS color values should be specified in hexadecimal
where possible.}}</li> | 47 <li>{{html-css-hexadecimal CSS color values should be specified in hexadecimal
where possible.}}</li> |
48 <li>{{html-css-shorthand CSS shorthand properties usage is optional.}}</li> | 48 <li>{{html-css-shorthand CSS shorthand properties usage is optional.}}</li> |
49 <li>{{html-css-order CSS rule declaration order should follow the <a href="htt
ps://make.wordpress.org/core/handbook/best-practices/coding-standards/css/#prope
rty-ordering">WordPress CSS Coding Standards</a>.}}</li> | 49 <li>{{html-css-order CSS rule declaration order should follow the <a href="htt
ps://make.wordpress.org/core/handbook/best-practices/coding-standards/css/#prope
rty-ordering">WordPress CSS Coding Standards</a>.}}</li> |
50 <li>{{html-css-units CSS number values should specify units where possible.}}<
/li> | 50 <li>{{html-css-units CSS number values should specify units where possible.}}<
/li> |
51 <li>{{html-css-leading-zero Don't omit the optional leading 0 for decimal numb
ers.}}</li> | 51 <li>{{html-css-leading-zero Don't omit the optional leading 0 for decimal numb
ers.}}</li> |
52 </ul> | 52 </ul> |
53 | 53 |
54 <h2 id="python">{{s19 Python}}</h2> | 54 <h2 id="python">{{s19 Python}}</h2> |
55 <ul> | 55 <ul> |
56 <li>{{python-general Follow <a href="https://www.python.org/dev/peps/pep-0008/
">PEP-8</a> and the recommendations in the offical Python documentation.}}</li> | 56 <li>{{python-general Follow <a href="https://www.python.org/dev/peps/pep-0008/
"><fix>PEP-8</fix></a> and the recommendations in the offical <fix>Python</fix>
documentation.}}</li> |
57 <li>{{python-version Make the code compatible with both Python 2.7 and Python
3.5+ (see <a href="https://docs.python.org/dev/howto/pyporting.html">this guide<
/a>). Use <a href="https://docs.python.org/2/library/__future__.html">__future__
imports</a> to address syntactic differences but avoid <a href="https://pythonh
osted.org/six/">six</a>, <a href="http://python-future.org/compatible_idioms.htm
l">python-future</a>, etc. to not introduce additional dependencies.}}</li> | 57 <li>{{python-version Make the code compatible with both <fix>Python 2.7</fix>
and <fix>Python 3.5+</fix> (see <a href="https://docs.python.org/dev/howto/pypor
ting.html">this guide</a>). Use <a href="https://docs.python.org/2/library/__fut
ure__.html"><fix>__future__</fix> imports</a> to address syntactic differences b
ut avoid <a href="https://pythonhosted.org/six/"><fix>six</fix></a>, <a href="ht
tp://python-future.org/compatible_idioms.html"><fix>python-future</fix></a>, etc
. to not introduce additional dependencies.}}</li> |
58 <li>{{python-strings Write string literals so that they match the behaviour of
<a href="https://docs.python.org/3/library/functions.html#ascii"><code><fix>asc
ii()</fix></code></a>, i.e. use single quotes except to avoid escaping of embedd
ed quotes and use <code><fix>\u</fix></code> escapes for non-ascii characters bu
t don't prefix strings with <code><fix>u</fix></code>. For docstrings, however,
follow <a href="https://www.python.org/dev/peps/pep-0257/">PEP-257</a>.}}</li> | 58 <li>{{python-strings Write string literals so that they match the behaviour of
<a href="https://docs.python.org/3/library/functions.html#ascii"><code><fix>asc
ii()</fix></code></a>, i.e. use single quotes except to avoid escaping of embedd
ed quotes and use <code><fix>\u</fix></code> escapes for non-ascii characters bu
t don't prefix strings with <code><fix>u</fix></code>. For docstrings, however,
follow <a href="https://www.python.org/dev/peps/pep-0257/">PEP-257</a>.}}</li> |
59 <li>{{python-prefix In modules, prefix private functions and variables with a
single underscore.}}</li> | 59 <li>{{python-prefix In modules, prefix private functions and variables with a
single underscore.}}</li> |
60 <li>{{python-concatenation Use the <code><fix>+</fix></code> operator when con
catenating exactly two strings, use the <a href="https://docs.python.org/2/libra
ry/stdtypes.html#str.format"><code><fix>format()</fix></code> method</a> for mor
e complex string formatting, use the <a href="https://docs.python.org/2/library/
stdtypes.html#str.join"><code><fix>join()</fix></code> method</a> when concatena
ting pre-existing sequences.}}</li> | 60 <li>{{python-concatenation Use the <code><fix>+</fix></code> operator when con
catenating exactly two strings, use the <a href="https://docs.python.org/2/libra
ry/stdtypes.html#str.format"><code><fix>format()</fix></code> method</a> for mor
e complex string formatting, use the <a href="https://docs.python.org/2/library/
stdtypes.html#str.join"><code><fix>join()</fix></code> method</a> when concatena
ting pre-existing sequences.}}</li> |
61 <li>{{python-tuple-vs-list Use tuples for data that have structure, use lists
for data that have order.}}</li> | 61 <li>{{python-tuple-vs-list Use tuples for data that have structure, use lists
for data that have order.}}</li> |
62 <li>{{python-builtins Don't override builtins except for <a href="https://docs
.python.org/2/library/functions.html#non-essential-built-in-funcs">non-essential
builtins</a> and <code><fix>file</fix></code> which is superfluos in modern cod
e as well.}}</li> | 62 <li>{{python-builtins Don't override builtins except for <a href="https://docs
.python.org/2/library/functions.html#non-essential-built-in-funcs">non-essential
builtins</a> and <code><fix>file</fix></code> which is superfluos in modern cod
e as well.}}</li> |
63 <li>{{python-map-filter Use list comprehensions or generator expressions inste
ad of calling <code><fix>map()</fix></code> or <code><fix>filter()</fix></code>
with a lambda function.}}</li> | 63 <li>{{python-map-filter Use list comprehensions or generator expressions inste
ad of calling <code><fix>map()</fix></code> or <code><fix>filter()</fix></code>
with a lambda function.}}</li> |
64 <li>{{python-regexp Use <a href="https://docs.python.org/2/library/re.html#re.
search"><code><fix>re.search()</fix></code></a> instead of <code><fix>re.match()
</fix></code> to avoid <a href="https://docs.python.org/2/library/re.html#search
-vs-match">confusion</a> about implied beginning of the string but not the endin
g.}}</li> | 64 <li>{{python-regexp Use <a href="https://docs.python.org/2/library/re.html#re.
search"><code><fix>re.search()</fix></code></a> instead of <code><fix>re.match()
</fix></code> to avoid <a href="https://docs.python.org/2/library/re.html#search
-vs-match">confusion</a> about implied beginning of the string but not the endin
g.}}</li> |
65 <li>{{python-flake8 Run <a href="https://pypi.python.org/pypi/flake8">flake8</
a> with the <a href="https://hg.adblockplus.org/codingtools/file/tip/flake8-abp"
>flake8-abp</a> and <a href="https://pypi.python.org/pypi/pep8-naming">pep8-nami
ng</a> extensions and fix any warning.}}</li> | 65 <li>{{python-flake8 Run <a href="https://pypi.python.org/pypi/flake8"><fix>fla
ke8</fix></a> with the <a href="https://hg.adblockplus.org/codingtools/file/tip/
flake8-eyeo"><fix>flake8-eyeo</fix></a> and <a href="https://pypi.python.org/pyp
i/pep8-naming"><fix>pep8-naming</fix></a> extensions and fix any warning.}}</li> |
66 <li>{{python-tests Write tests and have them run along flake8 using <a href="h
ttps://pypi.python.org/pypi/tox">tox</a>.}}</li> | 66 <li>{{python-tests Write tests and have them run along <fix>flake8</fix> using
<a href="https://pypi.python.org/pypi/tox"><fix>tox</fix></a>.}}</li> |
67 </ul> | 67 </ul> |
68 | 68 |
69 <h2 id="java">{{s22 Java}}</h2> | 69 <h2 id="java">{{s22 Java}}</h2> |
70 <ul> | 70 <ul> |
71 <li>{{s23 Follow the Mozilla Coding Style's <a href="https://developer.mozilla
.org/en-US/docs/Developer_Guide/Coding_Style#Java_practices">Java practices</a>.
}}</li> | 71 <li>{{s23 Follow the Mozilla Coding Style's <a href="https://developer.mozilla
.org/en-US/docs/Developer_Guide/Coding_Style#Java_practices">Java practices</a>.
}}</li> |
72 <li>{{s24 Imports should be organised consistently per file, we don't use glob
al rules.}}</li> | 72 <li>{{s24 Imports should be organised consistently per file, we don't use glob
al rules.}}</li> |
73 </ul> | 73 </ul> |
74 | 74 |
75 <h2 id="cpp">{{s25 C++}}</h2> | 75 <h2 id="cpp">{{s25 C++}}</h2> |
76 <ul> | 76 <ul> |
77 <li>{{s26 Follow the Mozilla Coding Style's <a href="https://developer.mozilla
.org/en-US/docs/Developer_Guide/Coding_Style#C.2FC.2B.2B_practices">C++ practice
s</a>.}}</li> | 77 <li>{{s26 Follow the Mozilla Coding Style's <a href="https://developer.mozilla
.org/en-US/docs/Developer_Guide/Coding_Style#C.2FC.2B.2B_practices">C++ practice
s</a>.}}</li> |
78 <li>{{s27 Indent namespace bodies.}}</li> | 78 <li>{{s27 Indent namespace bodies.}}</li> |
79 <li>{{s28 Avoid manual memory management: Use references and values when possi
ble, smart pointers when necessary, raw pointers only for weak references.}}</li
> | 79 <li>{{s28 Avoid manual memory management: Use references and values when possi
ble, smart pointers when necessary, raw pointers only for weak references.}}</li
> |
80 <li>{{s29 Don't use C-style casts unless its exact semantics are required.}}</
li> | 80 <li>{{s29 Don't use C-style casts unless its exact semantics are required.}}</
li> |
81 <li>{{s30 We tend to use anonymous namespaces instead of static.}}</li> | 81 <li>{{s30 We tend to use anonymous namespaces instead of static.}}</li> |
82 </ul> | 82 </ul> |
83 | 83 |
84 <h2 id="objc">{{objective-c Objective-C}}</h2> | 84 <h2 id="objc">{{objective-c Objective-C}}</h2> |
85 <ul> | 85 <ul> |
86 <li>{{objc-conventions Follow Apple's <a href="https://developer.apple.com/lib
rary/ios/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Conventions/Co
nventions.html">conventions</a>}}.</li> | 86 <li>{{objc-conventions Follow Apple's <a href="https://developer.apple.com/lib
rary/ios/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Conventions/Co
nventions.html">conventions</a>}}.</li> |
87 </ul> | 87 </ul> |
88 | 88 |
89 <h2 id="puppet">{{s31 Puppet}}</h2> | 89 <h2 id="puppet">{{s31 Puppet}}</h2> |
90 <ul> | 90 <ul> |
91 <li>{{s32 Follow the <a href="http://docs.puppetlabs.com/guides/style_guide.ht
ml">Puppet Style Guide</a>.}}</li> | 91 <li>{{s32 Follow the <a href="http://docs.puppetlabs.com/guides/style_guide.ht
ml">Puppet Style Guide</a>.}}</li> |
92 <li>{{s33 Opening braces don't go on their own line.}}</li> | 92 <li>{{s33 Opening braces don't go on their own line.}}</li> |
93 <li>{{s34 Arrows should not be aligned.}}</li> | 93 <li>{{s34 Arrows should not be aligned.}}</li> |
94 </ul> | 94 </ul> |
OLD | NEW |