| OLD | NEW |
| 1 { | 1 { |
| 2 "title": { | 2 "title": { |
| 3 "message": "Coding Style" | 3 "message": "Coding Style" |
| 4 }, | 4 }, |
| 5 "s1": { | 5 "s1": { |
| 6 "message": "Precedence" | 6 "message": "Precedence" |
| 7 }, | 7 }, |
| 8 "s2": { | 8 "s2": { |
| 9 "message": "The Adblock Plus coding style is based on others. The general se
ction below overrules any referenced style guides, and the language specific sec
tions overrule the general section." | 9 "message": "The Adblock Plus coding style is based on others. Our rules (bot
h general and language specific) always overrule referenced style guides. The la
nguage specific sections overrule the general section." |
| 10 }, | 10 }, |
| 11 "s3": { | 11 "s3": { |
| 12 "message": "Consistency" | 12 "message": "Consistency" |
| 13 }, | 13 }, |
| 14 "s4": { | 14 "s4": { |
| 15 "message": "Consistency is most important: Be consistent within functions, f
iles, modules and projects. Making existing code conform with this style guide i
s fine, but it should happen in dedicated commits, preferably for a whole module
or project at once." | 15 "message": "Consistency is most important: Be consistent within functions, f
iles, modules and projects. Making existing code conform with this style guide i
s fine, but it should happen in dedicated commits, preferably for a whole module
or project at once." |
| 16 }, | 16 }, |
| 17 "s5": { | 17 "s5": { |
| 18 "message": "General" | 18 "message": "General" |
| 19 }, | 19 }, |
| 20 "s6": { | 20 "s6": { |
| 21 "message": "Follow the Mozilla Coding Style's <a>general practices</a> and i
ts <a>naming and formatting rules</a>." | 21 "message": "Follow the Mozilla Coding Style's <a>general practices</a> and i
ts <a>naming and formatting rules</a>." |
| 22 }, | 22 }, |
| 23 "s7": { | 23 "s7": { |
| 24 "message": "All files should have a license header, but no mode line comment
s." | 24 "message": "Use 2 spaces per indentation level." |
| 25 }, | 25 }, |
| 26 "s8": { | 26 "s8": { |
| 27 "message": "Newline at end of file." | 27 "message": "All files should have a <a>license header</a>, but no mode line
comments." |
| 28 }, | 28 }, |
| 29 "s9": { | 29 "s9": { |
| 30 "message": "Lines can be longer than 80 characters if limiting line length w
ould hurt readability in a particular case." | 30 "message": "Newline at end of file, otherwise no trailing whitespace." |
| 31 }, | 31 }, |
| 32 "s10": { | 32 "s10": { |
| 33 "message": "Lines can be longer than the limit, if limiting line length woul
d hurt readability in a particular case." |
| 34 }, |
| 35 "s11": { |
| 33 "message": "Opening braces always go on their own line." | 36 "message": "Opening braces always go on their own line." |
| 34 }, | 37 }, |
| 35 "s11": { | 38 "s12": { |
| 36 "message": "No hungarian notation, no special variable name prefixes or suff
ixes denoting type or scope." | 39 "message": "No hungarian notation, no special variable name prefixes or suff
ixes denoting type or scope." |
| 37 }, | 40 }, |
| 38 "s12": { | 41 "s13": { |
| 42 "message": "Don't comment code out, delete it." |
| 43 }, |
| 44 "s14": { |
| 39 "message": "JavaScript" | 45 "message": "JavaScript" |
| 40 }, | 46 }, |
| 41 "s13": { | 47 "s15": { |
| 42 "message": "Follow the Mozilla Coding Style's <a>JavaScript practices</a>." | 48 "message": "Follow the Mozilla Coding Style's <a>JavaScript practices</a>." |
| 43 }, | 49 }, |
| 44 "s14": { | 50 "s16": { |
| 45 "message": "Opening braces of object literals don't go on their own line." | 51 "message": "Opening braces of object literals in don't go on their own line
when that would cause a syntax error." |
| 46 }, | 52 }, |
| 47 "s15": { | 53 "s17": { |
| 48 "message": "Use" | 54 "message": "Use" |
| 49 }, | 55 }, |
| 50 "s16": { | 56 "s18": { |
| 51 "message": "bind()" | 57 "message": "bind()" |
| 52 }, | 58 }, |
| 53 "s17": { | 59 "s19": { |
| 54 "message": "to ensure the desired value of the" | 60 "message": "to ensure the desired value of the" |
| 55 }, | 61 }, |
| 56 "s18": { | 62 "s20": { |
| 57 "message": "this" | 63 "message": "this" |
| 58 }, | 64 }, |
| 59 "s19": { | 65 "s21": { |
| 60 "message": "variable, don’t use temporary variables as a replacement." | 66 "message": "variable, don’t use temporary variables as a replacement." |
| 61 }, | 67 }, |
| 62 "s20": { | 68 "s22": { |
| 63 "message": "In classes, prefix private functions with a single underscore to
make them pseudo-private." | 69 "message": "In classes, prefix private functions with a single underscore to
make them pseudo-private." |
| 64 }, | 70 }, |
| 65 "s21": { | 71 "s23": { |
| 66 "message": "Python" | 72 "message": "Python" |
| 67 }, | 73 }, |
| 68 "s22": { | 74 "s24": { |
| 69 "message": "Follow the Mozilla Coding Style's <a>Python practices</a>." | 75 "message": "Follow the Mozilla Coding Style's <a>Python practices</a>." |
| 70 }, | 76 }, |
| 71 "s23": { | 77 "s25": { |
| 72 "message": "In modules, prefix private functions and variables with a single
underscore." | 78 "message": "In modules, prefix private functions and variables with a single
underscore." |
| 73 }, | 79 }, |
| 74 "s24": { | 80 "s26": { |
| 75 "message": "Java" | 81 "message": "Java" |
| 76 }, | 82 }, |
| 77 "s25": { | 83 "s27": { |
| 78 "message": "Follow the Mozilla Coding Style's <a>Java practices</a>." | 84 "message": "Follow the Mozilla Coding Style's <a>Java practices</a>." |
| 79 }, | 85 }, |
| 80 "s26": { | 86 "s28": { |
| 87 "message": "Imports should be organised consistently per file, we don't use
global rules." |
| 88 }, |
| 89 "s29": { |
| 81 "message": "C++" | 90 "message": "C++" |
| 82 }, | 91 }, |
| 83 "s27": { | 92 "s30": { |
| 84 "message": "Follow the Mozilla Coding Style's <a>C++ practices</a>." | 93 "message": "Follow the Mozilla Coding Style's <a>C++ practices</a>." |
| 85 }, | 94 }, |
| 86 "s28": { | 95 "s31": { |
| 87 "message": "Indent namespace bodies." | 96 "message": "Indent namespace bodies." |
| 88 }, | 97 }, |
| 89 "s29": { | |
| 90 "message": "Don't use anything from C++11." | |
| 91 }, | |
| 92 "s30": { | |
| 93 "message": "std::tr1" | |
| 94 }, | |
| 95 "s31": { | |
| 96 "message": "can and should be used." | |
| 97 }, | |
| 98 "s32": { | 98 "s32": { |
| 99 "message": "Avoid manual memory management: Use references and values when p
ossible, smart pointers when necessary, raw pointers only for weak references." | 99 "message": "Avoid manual memory management: Use references and values when p
ossible, smart pointers when necessary, raw pointers only for weak references." |
| 100 }, | 100 }, |
| 101 "s33": { | 101 "s33": { |
| 102 "message": "Don't use C-style casts unless its exact semantics are required.
" |
| 103 }, |
| 104 "s34": { |
| 105 "message": "We tend to use anonymous namespaces instead of static." |
| 106 }, |
| 107 "s35": { |
| 102 "message": "Puppet" | 108 "message": "Puppet" |
| 103 }, | 109 }, |
| 104 "s34": { | 110 "s36": { |
| 105 "message": "Follow the <a>Puppet Style Guide</a>." | 111 "message": "Follow the <a>Puppet Style Guide</a>." |
| 106 }, | 112 }, |
| 107 "s35": { | 113 "s37": { |
| 108 "message": "Opening braces don't go on their own line." | 114 "message": "Opening braces don't go on their own line." |
| 109 } | 115 } |
| 110 } | 116 } |
| OLD | NEW |