Added option to add file header comment

Author: jeffreylanters

Editor/GenerateFileEditorWindow.cs

@@ -17,6 +17,7 @@ public class GenerateFileEditorWindow : EditorWindow {
     private string fileName;
     private bool shouldOverwriteAllVirtuals;
     private bool shouldImportCommonNamespaces;
+    private bool shouldAddFileHeaderComments;
 
     [MenuItem ("ECS/Generate Controller", false, 100)]
     private static void GenerateNewController () {
@@ -53,6 +54,7 @@ private void OnGUI () {
       GUILayout.FlexibleSpace ();
       this.shouldImportCommonNamespaces = GUILayout.Toggle (this.shouldImportCommonNamespaces, " Import Common Namespaces");
       this.shouldOverwriteAllVirtuals = GUILayout.Toggle (this.shouldOverwriteAllVirtuals, " Overwrite All Virtuals");
+      this.shouldAddFileHeaderComments = GUILayout.Toggle (this.shouldAddFileHeaderComments, " Add File Header Comments");
       GUILayout.FlexibleSpace ();
       if (GenerateFileEditorWindow.generateFileType == GenerateFileType.Controller) {
         if (GUILayout.Button ("Generate " + this.fileName + "Controller"))
@@ -72,6 +74,7 @@ private void OnGUI () {
     private void Generate () {
       var _overwriteAllVirtuals = this.shouldOverwriteAllVirtuals;
       var _importCommonNamespaces = this.shouldImportCommonNamespaces;
+      var _addFileHeaderComments = this.shouldAddFileHeaderComments;
       var _fileName = this.fileName;
       this.fileName = "";
 
@@ -80,7 +83,14 @@ private void Generate () {
           _importCommonNamespaces ? "using UnityEngine;" : null,
           "using ElRaccoone.EntityComponentSystem;",
           _importCommonNamespaces ? "using System.Collections.Generic;" : null,
-          "public class " + _fileName + "Controller  : Controller {",
+          "",
+          _addFileHeaderComments ? "/*" : null,
+          _addFileHeaderComments ? " * Project: " + PlayerSettings.productName : null,
+          _addFileHeaderComments ? " * Author: " : null,
+          _addFileHeaderComments ? " *" : null,
+          _addFileHeaderComments ? " * Controller for " + _fileName + "." : null,
+          _addFileHeaderComments ? " */" : null,
+          "public class " + _fileName + "Controller : Controller {",
           "\tpublic override void OnInitialize () {",
           "\t\tthis.Register();",
           "\t}",
@@ -94,6 +104,13 @@ private void Generate () {
           _importCommonNamespaces? "using UnityEngine;" : null,
           "using ElRaccoone.EntityComponentSystem;",
           _importCommonNamespaces? "using System.Collections.Generic;" : null,
+          "",
+          _addFileHeaderComments ? "/*" : null,
+          _addFileHeaderComments ? " * Project: " + PlayerSettings.productName : null,
+          _addFileHeaderComments ? " * Author: " : null,
+          _addFileHeaderComments ? " *" : null,
+          _addFileHeaderComments ? " * Entity Component for " + _fileName + "." : null,
+          _addFileHeaderComments ? " */" : null,
           "public class " + _fileName + "Component : EntityComponent<" + _fileName + "Component, " + _fileName + "System> {",
           "}"
         });
@@ -103,6 +120,13 @@ private void Generate () {
           _importCommonNamespaces? "using UnityEngine;" : null,
           "using ElRaccoone.EntityComponentSystem;",
           _importCommonNamespaces? "using System.Collections.Generic;" : null,
+          "",
+          _addFileHeaderComments ? "/*" : null,
+          _addFileHeaderComments ? " * Project: " + PlayerSettings.productName : null,
+          _addFileHeaderComments ? " * Author: " : null,
+          _addFileHeaderComments ? " *" : null,
+          _addFileHeaderComments ? " * Entity System for " + _fileName + "." : null,
+          _addFileHeaderComments ? " */" : null,
           "public class " + _fileName + "System : EntitySystem<" + _fileName + "System, " + _fileName + "Component> {",
           _overwriteAllVirtuals ? "\tpublic override void OnInitialize () { }" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnInitialized () { }" : null,
@@ -125,6 +149,13 @@ private void Generate () {
           _importCommonNamespaces? "using UnityEngine;" : null,
           "using ElRaccoone.EntityComponentSystem;",
           _importCommonNamespaces? "using System.Collections.Generic;" : null,
+          "",
+          _addFileHeaderComments ? "/*" : null,
+          _addFileHeaderComments ? " * Project: " + PlayerSettings.productName : null,
+          _addFileHeaderComments ? " * Author: " : null,
+          _addFileHeaderComments ? " *" : null,
+          _addFileHeaderComments ? " * Service for " + _fileName + "." : null,
+          _addFileHeaderComments ? " */" : null,
           "public class " + _fileName + "Service : Service<" + _fileName + "Service> {",
           _overwriteAllVirtuals ? "\tpublic override void OnInitialize () { }" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnInitialized () { }" : null,

README.md

@@ -4,7 +4,7 @@
 
 # Entity Component System
 
-[![npm](https://img.shields.io/badge/upm-3.4.0-232c37.svg?style=for-the-badge)]()
+[![npm](https://img.shields.io/badge/upm-3.4.1-232c37.svg?style=for-the-badge)]()
 [![license](https://img.shields.io/badge/license-Custom-%23ecc531.svg?style=for-the-badge)](./LICENSE.md)
 [![npm](https://img.shields.io/badge/sponsor-donate-E12C9A.svg?style=for-the-badge)](https://paypal.me/jeffreylanters)
 [![npm](https://img.shields.io/github/stars/elraccoone/unity-entity-component-system.svg?style=for-the-badge)]()

package.json

@@ -1,7 +1,7 @@
 {
   "name": "nl.elraccoone.entity-component-system",
   "displayName": "Entity Component System",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "unity": "2019.1",
   "description": "A better approach to game design that allows you to concentrate on the actual problems you are solving: the data and behavior that make up your game. By moving from object-oriented to data-oriented design it will be easier for you to reuse the code and easier for others to understand and work on it."
 }