Changes between Version 49 and Version 50 of Coding_Conventions

Timestamp:

Apr 11, 2020, 11:35:05 AM (4 years ago)

Author:

Freagarach

Comment:

Inline example instead of link.

Coding_Conventions

@@ -348 +348 @@
  * Use roughly the same Doxygen-style comments for documentation as described above for C++. (But we don't actually run Doxygen on the JS code, so there's no need to make the comments use technically correct Doxygen syntax.)
 
- * We've recently been switching to Class syntax for JS (see e.g. [https://code.wildfiregames.com/P169]).
-   * Literals are stored in the prototype (e.g. `BuildingAI.prototype.MAX_PREFERENCE_BONUS = 2;`).
+ * When using Class syntax for JS:
+   * Literals are stored in the prototype (e.g. `BuildingAI.prototype.MaxPreferenceBonus = 2;`).
    * The Schema is also a literal and hence is stored in the prototype.
-   * We don't want to rewrite components just for the sake of it, but new components should be written in the class syntax and major rewrites can opt to use the class syntax.
+{{{
+#!js
+class Example
+{
+    Init()
+    {
+      this.value = 0;
+    }
+}
+
+Example.prototype.Schema = 
+    "<empty/>";
+
+Example.prototype.MaxValue = 2;
+
+Engine.RegisterComponentType(IID_Example, "Example", Example);
+}}}
 
  * Don't omit the optional semicolons after statements.