Fixed visualpython#155 - Add 'Comment Template' to comment logic block.

Minku-Koo · Minku-Koo · commit 618c3611d6ec · 2023-04-04T01:21:30.000+09:00
- Add comment templates consisting of default, class and method
diff --git a/visualpython/js/m_logic/Comment.js b/visualpython/js/m_logic/Comment.js
@@ -5,7 +5,7 @@
  *    Author          : Black Logic
  *    Note            : Logic > comment
  *    License         : GNU GPLv3 with Visual Python special exception
- *    Date            : 2021. 11. 18
+ *    Date            : 2023. 04. 04
  *    Change Date     :
  */
 
@@ -18,6 +18,61 @@ define([
 ], function(com_String, PopupComponent) {
 
     const COMMENT_DEFAULT_CODE = '# Write down comments'
+    // Templates from NumPy Style Python Docstrings.
+    const COMMENT_CLASS_TEMPLATE = 
+`"""Summarize the class in one line.
+
+Several sentences ...
+providing an extended description.
+
+Note
+----------
+Note about this class.
+
+Parameters
+----------
+param1 : param_type
+    Parameter description.
+param2 : param_type
+    Parameter description.
+
+Attributes
+----------
+attr1 : attr_type
+    Attibute description.
+attr2 : attr_type
+    Attibute description.
+
+Examples
+----------
+    
+References
+----------
+"""`
+    const COMMENT_METHOD_TEMPLATE = 
+`"""Summarize the function in one line.
+
+Several sentences ...
+providing an extended description.
+
+Parameters
+----------
+param1 : param_type
+    Parameter description.
+param2 : param_type
+    Parameter description.
+
+Returns
+-------
+return_type
+    Return description.
+
+Note
+----------
+
+Examples
+----------
+"""`
 
     /**
      * Comment
@@ -29,25 +84,63 @@ define([
             this.config.dataview = false;
             this.config.codeview = false;
             this.config.saveOnly = true;
+            this.selectBoxClassName = 'vp-ct-option'; // Select Box ClassName
 
             this.state = {
                 code: COMMENT_DEFAULT_CODE,
                 ...this.state
             }
-            
+
+            this.cmTemplates = { // a kind of templates
+                Default : COMMENT_DEFAULT_CODE,
+                Class : COMMENT_CLASS_TEMPLATE,
+                Method : COMMENT_METHOD_TEMPLATE
+            }
+
             this._addCodemirror('code', this.wrapSelector('#code'));
         }
 
         _bindEvent() {
             super._bindEvent();
-            /** Implement binding events */
+            
+            var commentTemplates = this.cmTemplates;
+            let cmCodeListTemp = this.cmCodeList;
+
+            $('.' + this.selectBoxClassName).on('change', function(){
+                // get code mirror object
+                let targetCmObj = cmCodeListTemp.filter(obj => obj.key == 'code');
+                var templateOption = $(this).val();
+                let cm = targetCmObj[0].cm;
+
+                // Change Code Mirror Text
+                if(templateOption == 'vp_template_class'){
+                    cm.setValue(commentTemplates.Class);
+                }else if(templateOption == 'vp_template_method'){
+                    cm.setValue(commentTemplates.Method);
+                }else if(templateOption == 'vp_template_default'){
+                    cm.setValue(commentTemplates.Default);
+                }
+
+                cm.save();
+            });
         }
 
         templateForBody() {
             /** Implement generating template */
             var page = new com_String();
             page.appendFormatLine('<textarea name="code" class="code vp-state" id="code">{0}</textarea>'
                                 , this.state.code);
+            
+            // add select box
+            page.appendFormatLine('<select class="vp-select w100 {0}" >', this.selectBoxClassName);
+            // add options
+            Object.entries(this.cmTemplates).forEach(([optionValue, t_code]) => {
+                page.appendFormatLine('<option value="{0}">{1}</option>', 
+                                        'vp_template_' + optionValue.toLowerCase(),
+                                        optionValue);
+            });
+            page.appendFormatLine('</select>');
+
             return page.toString();
         }
 
