Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
minjk-bl merged 1 commit into from
Apr 10, 2023
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 83 additions & 3 deletions visualpython/js/m_logic/Comment.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,51 @@ 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
Expand All @@ -29,9 +74,13 @@ define([
this.config.dataview = false;
this.config.codeview = false;
this.config.saveOnly = true;
this.selectBoxClassName = 'vp-ct-option'; // Select Box ClassName
this.selectOptionPrefix = 'vp_template_'; // Select Options Class Prefix Name

this.state = {
code: COMMENT_DEFAULT_CODE,
v1: {"name": "Default", "code": COMMENT_DEFAULT_CODE},
v2 : {"name": "Class", "code": COMMENT_CLASS_TEMPLATE},
v3 : {"name": "Method", "code": COMMENT_METHOD_TEMPLATE},
...this.state
}

Expand All @@ -40,14 +89,45 @@ define([

_bindEvent() {
super._bindEvent();
/** Implement binding events */

var commentTemplates = this.state;
let cmCodeListTemp = this.cmCodeList;

$('.' + this.selectBoxClassName).on('change', function(){
// get code mirror object
let targetCmObj = cmCodeListTemp.filter(obj => obj.key == 'code');
let cm = targetCmObj[0].cm;
var templateOption = $(this).val();

// Change Code Mirror Text
if(templateOption == commentTemplates.v1['name']){
cm.setValue(commentTemplates.v1['code']);
}else if(templateOption == commentTemplates.v2['name']){
cm.setValue(commentTemplates.v2['code']);
}else if(templateOption == commentTemplates.v3['name']){
cm.setValue(commentTemplates.v3['code']);
}
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);
, this.state.v1['code']);

// add select box
page.appendFormatLine('<select class="vp-select w100 {0}" >', this.selectBoxClassName);
for (var key in this.state) {
var optionName = this.state[key]['name'];
page.appendFormatLine('<option value="{0}" id="{1}">{2}</option>',
optionName,
this.selectOptionPrefix + optionName,
optionName);
}
page.appendFormatLine('</select>');

return page.toString();
}

Expand Down