Write coding standards for bat/PS #117
Labels
No labels
_CRITICAL_
API
app
backEnd
Blocked-waiting-for-further-changes
bug
bug-only-on-server-for-mobile-not-webpage
Bug-Report-After-Merge
cleanup
close
design
duplicate
enhancement
feature request
frontEnd
further-changes-needed
future-problem-not-fixint-this-period
help wanted
invalid
last-week-issue-to-fix
library
low-priority
needs input
needs review
not-implemented.
project documentation
question
research
reviewed
Script
security
SQL
style
Team 1
Team 2
team leaders
test-creation
testing
topLevel
unassigned
Under-review
wontfix
No milestone
No project
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
Andras/BoundlessFlowCampus2K#117
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Parent issue: #8
Bad version 1 done.
I will later rewrite it to grammatically work before wanting a review.
Besides that, a basic version now exists
Update much of the document
I think the coding standard part is missing? Right now it feels more like a "how to write bat scripts" rather than "this is how the code should look". For example regarding commenting you say that there are two ways to do comments, but you do not pick one that should be used nor how it should be used, like comments before or after the statement?
The naming convention is good and is a coding standard.
I noticed that this issue is still open and decided to look it through as well, and I was wondering:
Why do we have two wiki-pages for scripting when the level of the scripts are so simple that there is no difference between them and probably won't be in the future.
I took some time to just merge them together in this page. Thoughts?
Looks good! Could just add the naming convention bit from the top of bat/PS
"Variables are written in camelCase in this application (e.g., someVariable).
Files follow the same convention as variables, using camelCase for the application. Example: "someScript.bat"
Comments should be short and descriptive."
I added convention based on what is normal for that language. Bash often use snake_case, while Batch uses camelCase, and also while we name our files in PascalCase. I think it is best to keep the file name standard as is and write the scripts in what is normal for those. I've written the Wiki accordinly.
I also added the part about the comments.
Updated the wiki to reflect what we discussed here and closing this issue.
Scripting