commit 217c0df87c677e57747d66f95bc4c94486b77951
parent c7bb092fa2b1732ebebc07fe26addeab86e2a412
Author: finwo <finwo@pm.me>
Date: Thu, 16 Aug 2018 15:01:12 +0200
Separated spec0001 in pages
Diffstat:
| M | spec/spec0001.txt | | | 215 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---- |
1 file changed, 205 insertions(+), 10 deletions(-)
diff --git a/spec/spec0001.txt b/spec/spec0001.txt
@@ -4,16 +4,9 @@ Specification: 0001 Robin Bron
Javascript Styling
-Bron [Page 11]
-SPEC 0001 Javascript Styling August 2018
-Copyright Notice
- This document is licensed under a
- Creative Commons Attribution 4.0 International License
- You should have received a copy of the license along with this work.
- If not, see <http://creativecommons.org/licenses/by/4.0/>
@@ -56,8 +49,13 @@ Copyright Notice
+Copyright Notice
+ This document is licensed under a
+ Creative Commons Attribution 4.0 International License
+ You should have received a copy of the license along with this work.
+ If not, see <http://creativecommons.org/licenses/by/4.0/>
Bron [Page 1]
SPEC 0001 Javascript Styling August 2018
@@ -117,6 +115,11 @@ Table of contents
5.10. Property comments
5.11. Nullability
5.12. Template parameter types
+
+
+Bron [Page 2]
+SPEC 0001 Javascript Styling August 2018
+
6. Policies
6.1. Unspecified styling
6.2. Deprecation
@@ -126,6 +129,56 @@ Table of contents
6.4. Local style rules
6.5. Generated code
6.6. Third-party code
+ 7. Informative resources
+ 8. Author information
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Bron [Page 3]
+SPEC 0001 Javascript Styling August 2018
1. Introduction
@@ -184,6 +237,9 @@ Table of contents
used, depending only on which makes the code easier to read
and understand.
+Bron [Page 4]
+SPEC 0001 Javascript Styling August 2018
+
3. Formatting
3.1. Braces
@@ -239,6 +295,11 @@ Table of contents
of the enclosing block if the whitespace does not affect
functionality or complicates the code.
+
+
+Bron [Page 5]
+SPEC 0001 Javascript Styling August 2018
+
3.4. Number literals
Numbers may be specified in decimal, hexidecimal, octal or
@@ -296,6 +357,9 @@ Table of contents
shorthand in place of a colon immediately followed by a function
or arrow function literal to be consistent with class literals.
+Bron [Page 6]
+SPEC 0001 Javascript Styling August 2018
+
3.7. Functions
3.7.1. Function literals
@@ -352,6 +416,10 @@ Table of contents
than a small handful of optional parameters that do not
have a natural order.
+
+Bron [Page 7]
+SPEC 0001 Javascript Styling August 2018
+
3.7.4.2. Rest parameters
Use a rest parameter instead of accessing the special
@@ -405,6 +473,13 @@ Table of contents
class exists. Methods SHOULD be defined on the prototype of
the constructor.
+
+
+
+
+Bron [Page 8]
+SPEC 0001 Javascript Styling August 2018
+
3.8.4. Prototype manipulation
In ES6 class definitions, the prototype of the class SHOULD
@@ -461,6 +536,10 @@ Table of contents
as functions for coercing (which is preferred over using "+"
or concatenating the empty string) or creating Symbols.
+
+Bron [Page 9]
+SPEC 0001 Javascript Styling August 2018
+
4. Naming
4.1. Rules for all identifiers
@@ -513,6 +592,14 @@ Table of contents
overviews to allow the user to skim the documentation in search
of the required template.
+
+
+
+
+
+Bron [Page 10]
+SPEC 0001 Javascript Styling August 2018
+
5.3. Description
The description contains concise information about the function
@@ -532,6 +619,47 @@ Table of contents
information (such as {@link}). Inline tags MUST always be
surrounded by braces.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Bron [Page 11]
+SPEC 0001 Javascript Styling August 2018
+
5.4. Tags
Tags represent metadata with which IDEs, external tooling or even
@@ -585,6 +713,13 @@ Table of contents
@deprecated Indicates the documented element is deprecated
and this SHOULD not be used in new code.
+
+
+
+
+Bron [Page 12]
+SPEC 0001 Javascript Styling August 2018
+
5.5. Line wrapping
Line-wrapped block texts MUST be indented four spaces or be
@@ -638,6 +773,13 @@ Table of contents
be specified inline if the automatic type inference is
insufficient.
+
+
+
+
+Bron [Page 13]
+SPEC 0001 Javascript Styling August 2018
+
5.10. Property comments
Property types must be documented. The description may be omitted
@@ -694,6 +836,10 @@ Table of contents
a position on some issue, or may be in non-TrackThis Style for
any other reason.
+
+Bron [Page 14]
+SPEC 0001 Javascript Styling August 2018
+
6.3.1. Reformatting existing code
When working on the file, only reformat the functions and/or
@@ -742,7 +888,19 @@ Table of contents
package, you MUST follow the style guide supplied by that project
if available.
-N. Informative resources
+
+
+
+
+
+
+
+
+
+Bron [Page 15]
+SPEC 0001 Javascript Styling August 2018
+
+7. Informative resources
[JSGUIDE] Google JavaScript Style Guide
https://google.github.io/styleguide/jsguide.html
@@ -765,7 +923,44 @@ N. Informative resources
F. Yergeau
https://tools.ietf.org/html/rfc3629
-N. Author information
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Bron [Page 16]
+SPEC 0001 Javascript Styling August 2018
+
+8. Author information
Name ....... Robin Bron
Nickname ... Finwo
@@ -822,4 +1017,4 @@ N. Author information
-Bron [Page N]
+Bron [Page 17]
