Add the JerryScript Coding Standards #1459

zherczeg · 2016-11-29T10:09:53Z

No description provided.

galpeter · 2016-11-29T10:31:29Z

docs/07.CODING-GUIDELINES.md

+```
+
+All types, constants, and functions require a description in
+JerryScript. These comments should start with /**. The starting


The /**. and /** will make the string between them bold, so what you wanted to write disappears.
example: /. my text / in raw: /**. my text /**.
IMHO we should but such special characters in the description between backticks (`).

galpeter · 2016-11-29T10:34:05Z

docs/07.CODING-GUIDELINES.md

+part of a comment should focus on explaing "why" rather than
+"what".
+
+```diff


Using "diff entries" as separator seems weird for me. Can't we just use a simple header style?

galpeter · 2016-11-29T10:35:00Z

docs/07.CODING-GUIDELINES.md

+
+## Conditional preprocessor directives
+
+A comment is required after #else and #endif in JerryScript.


IMHO: #else and #endif should be between backticks so they will appear as inline code. (Also applies to keywords and any other code related pars in the descriptions)

LaszloLango · 2016-12-02T12:39:50Z

LGTM

zherczeg · 2016-12-05T08:54:22Z

@LaszloLango added an extra section about expressions. Please check the patch again.

galpeter · 2016-12-05T09:04:27Z

docs/07.CODING-GUIDELINES.md

+part of a comment should focus on explaing *why* rather than
+*what*.
+
+```diff


Why not a simple header, like this?

Good

Not visible enough.

I agree with @galpeter, can't we have a standard header that is visible enough? E.g. change the color of the font?
Right now it seems you are using code blocks for the headers which seems suboptimal :)

tilmannOSG

Did a first round of reviewing, thanks for taking the initiative on this!

tilmannOSG · 2016-12-05T12:21:05Z

docs/07.CODING-GUIDELINES.md

@@ -0,0 +1,679 @@
+# Coding style guidelines for the JerryScript project


How about changing this to "JerryScript Coding Standards" + changing the filename to "07.CODING-STANDARDS"? "Coding Standards" seems to be the most common term for this kind of document (vs. coding style guide, coding conventions, etc.).

tilmannOSG · 2016-12-05T12:22:12Z

docs/07.CODING-GUIDELINES.md

@@ -0,0 +1,679 @@
+# Coding style guidelines for the JerryScript project
+
+This text is a brief overview of JerryScript coding style.


JerryScript coding style -> JerryScript Coding Standards

tilmannOSG · 2016-12-05T12:25:13Z

docs/07.CODING-GUIDELINES.md

+
+* Indentation is two spaces.
+* Tab characters are not allowed.
+* Maximum line length is 120 characters long (excluding newline).


tilmannOSG · 2016-12-05T12:26:22Z

docs/07.CODING-GUIDELINES.md

+* Indentation is two spaces.
+* Tab characters are not allowed.
+* Maximum line length is 120 characters long (excluding newline).
+* No trailing white spaces are allowed.


white spaces are allowed -> white space is allowed

tilmannOSG · 2016-12-05T12:28:17Z

docs/07.CODING-GUIDELINES.md

+* Tab characters are not allowed.
+* Maximum line length is 120 characters long (excluding newline).
+* No trailing white spaces are allowed.
+* Run `tools/run-tests.py --check-vera` to check majority of the style rules.


Majority seems a bit of a stretch :) How about "Run tools/run-tests.py --check-vera to check several of the coding conventions automatically."?

tilmannOSG · 2016-12-05T13:38:50Z

docs/07.CODING-GUIDELINES.md

+
+Each type in jerryscript must be a lowercase string
+which is ended by `_t` characters. Furthermore each type
+declaration must be preceeded by a short description


preceeded -> preceded

tilmannOSG · 2016-12-05T13:39:10Z

docs/07.CODING-GUIDELINES.md

+Each type in jerryscript must be a lowercase string
+which is ended by `_t` characters. Furthermore each type
+declaration must be preceeded by a short description
+about the type and each field must have a short description


about -> of

tilmannOSG · 2016-12-05T13:39:40Z

docs/07.CODING-GUIDELINES.md

+
+```c
+/**
+ * Short description about the following structure.


about -> of

tilmannOSG · 2016-12-05T13:40:48Z

docs/07.CODING-GUIDELINES.md

+typedef struct
+{
+  /* Field descriptions do not start with capital letters
+   * and there is no full stops at the end. */


stops -> stop

tilmannOSG · 2016-12-05T13:43:16Z

docs/07.CODING-GUIDELINES.md

+## Function declarations
+
+Function declarations in JerryScript are verbose but this format
+reduces maintenance costs and allows faster understanding of the


reduces maintenance costs -> reduces the maintenance cost

tilmannOSG

Thanks for addressing my feedback :) Did a second round of reviewing.

tilmannOSG · 2016-12-07T12:33:42Z

docs/07.CODING-STANDARDS.md

+is doing.
+
+```diff
+++ Good +++


Did you investigate better ways to format this with Markdown?

Yes. According to several sources github markdown does not support colors. I wish to keep this format.

tilmannOSG · 2016-12-07T12:34:25Z

docs/07.CODING-STANDARDS.md

+
+All types, constants and functions require a description in
+JerryScript. These comments should start with `/**`. The starting
+`/**` and ending `*/` must be in separate line.


in separate line -> on separate lines

tilmannOSG · 2016-12-07T12:35:14Z

docs/07.CODING-STANDARDS.md

+## Preprocessor defines
+
+The name of a preprocessor macro must be an uppercase string
+and these macros must be preceeded by a description.


preceeded -> preceded

tilmannOSG · 2016-12-07T12:38:53Z

docs/07.CODING-STANDARDS.md

+* Only a single newline separator is allowed.
+* Source files must be terminated by a newline.
+* Global declarations must be separated by a newline.
+* Newlines are not allowed after an open brace or before a close brace.


open brace or before a close brace -> opening curly brace or before a closing curly brace

tilmannOSG · 2016-12-07T12:39:12Z

docs/07.CODING-STANDARDS.md

+* Source files must be terminated by a newline.
+* Global declarations must be separated by a newline.
+* Newlines are not allowed after an open brace or before a close brace.
+* No newlines are allowed between control staments (if-else, while,


staments -> statements

tilmannOSG · 2016-12-07T12:54:36Z

docs/07.CODING-STANDARDS.md

+                        b,
+                        c);
+```
+


function_c (a, b, c); function_c (a, b, function_c (a, b, c);

Should be moved to the bad section :)

tilmannOSG · 2016-12-07T12:55:38Z

docs/07.CODING-STANDARDS.md

+
+## Variable declarations
+
+JerryScript requires C99 standard support so variable


JerryScript requires C99 standard support -> JerryScript is a pure C99 codebase

tilmannOSG · 2016-12-07T12:56:55Z

docs/07.CODING-STANDARDS.md

+   * declarations. A reviewer might request such a change. */
+  int ***int_p;
+
+  /* This rule true for type casting as well. */


This rule true for -> This rule applies for

tilmannOSG · 2016-12-07T12:57:34Z

docs/07.CODING-STANDARDS.md

+
+## Types
+
+Each type in jerryscript must be a lowercase string


jerryscript -> JerryScript

tilmannOSG · 2016-12-07T12:58:11Z

docs/07.CODING-STANDARDS.md

+## Types
+
+Each type in jerryscript must be a lowercase string
+which is which ends with a `_t` suffix. Furthermore


Please remove the "which is".

JerryScript-DCO-1.0-Signed-off-by: Zoltan Herczeg [email protected]

jiangzidong · 2017-04-13T06:33:25Z

What's the right style if a function call statement is exceed 120 limit. Only one actual parameter in the function
e.g.

ret_name = function_name (arg_name);

The above thing will happen if the names of ret, function and arg are too long.

LaszloLango · 2017-04-13T06:46:40Z

I'd say that you should use shorter function and variable names. :) IMHO too long names are as bad as too short ones. But this is only my personal preference.

zherczeg · 2017-04-13T07:40:03Z

Perhaps we should land this PR sometimes.

LaszloLango · 2017-04-13T07:41:34Z

Still LGTM from my side.

jiangzidong · 2017-04-13T07:42:05Z

LGTM

yichoi · 2017-04-13T07:44:23Z

Do we need more discussion?

zherczeg · 2017-04-13T07:47:52Z

I have no more to add.

yichoi · 2017-04-13T07:52:45Z

Ok. Landing this. if needed, we can duscuss further.

galpeter reviewed Nov 29, 2016

View reviewed changes

zherczeg force-pushed the coding_guidelines branch 4 times, most recently from 4662b84 to ea0478e Compare November 29, 2016 10:46

This was referenced Nov 30, 2016

[WIP] Emscripten implementation of jerry-api.h #1432

Closed

add ES6 feature: ArrayBuffer #1467

Merged

zherczeg force-pushed the coding_guidelines branch 2 times, most recently from c705b73 to 31e4639 Compare December 5, 2016 08:53

zherczeg force-pushed the coding_guidelines branch from 31e4639 to 551b005 Compare December 5, 2016 08:59

galpeter reviewed Dec 5, 2016

View reviewed changes

tilmannOSG requested changes Dec 5, 2016

View reviewed changes

zherczeg force-pushed the coding_guidelines branch 4 times, most recently from 5ffd972 to e694af9 Compare December 6, 2016 12:32

tilmannOSG requested changes Dec 7, 2016

View reviewed changes

zherczeg force-pushed the coding_guidelines branch 2 times, most recently from 28d8b1d to f302710 Compare December 12, 2016 07:54

tilmannOSG changed the title ~~Add documentation about the Coding Guidelines~~ Add the JerryScript Coding Standards Dec 12, 2016

Add documentation about the Coding Guidelines

826f98a

JerryScript-DCO-1.0-Signed-off-by: Zoltan Herczeg [email protected]

zherczeg force-pushed the coding_guidelines branch from f302710 to 826f98a Compare March 29, 2017 08:48

jiangzidong mentioned this pull request Mar 29, 2017

Implement the basic Promise #1695

Merged

zherczeg mentioned this pull request Apr 11, 2017

Support a user context void * pointer in jerry_context_t (#1717) #1727

Merged

yichoi merged commit 239ae49 into jerryscript-project:master Apr 13, 2017

zherczeg deleted the coding_guidelines branch April 19, 2017 11:44


		## Conditional preprocessor directives

		A comment is required after #else and #endif in JerryScript.

		@@ -0,0 +1,679 @@
		# Coding style guidelines for the JerryScript project

		@@ -0,0 +1,679 @@
		# Coding style guidelines for the JerryScript project

		This text is a brief overview of JerryScript coding style.


		## Variable declarations

		JerryScript requires C99 standard support so variable

Add the JerryScript Coding Standards #1459

Add the JerryScript Coding Standards #1459

Uh oh!

Conversation

zherczeg commented Nov 29, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LaszloLango commented Dec 2, 2016

Uh oh!

zherczeg commented Dec 5, 2016

Uh oh!

Choose a reason for hiding this comment

Good

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tilmannOSG left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tilmannOSG left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jiangzidong commented Apr 13, 2017

Uh oh!

LaszloLango commented Apr 13, 2017

Uh oh!

zherczeg commented Apr 13, 2017

Uh oh!

LaszloLango commented Apr 13, 2017

Uh oh!

jiangzidong commented Apr 13, 2017