Write coding standards for bat/PS #117

Closed
opened 2026-04-02 08:14:48 +00:00 by a24timsv · 7 comments
Collaborator

Parent issue: #8

Parent issue: #8
Collaborator

Bad version 1 done.
I will later rewrite it to grammatically work before wanting a review.

Besides that, a basic version now exists

Bad version 1 done. I will later rewrite it to grammatically work before wanting a review. Besides that, a basic version now exists
Collaborator

Update much of the document

Update much of the document
Collaborator

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 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.
Author
Collaborator

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?

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](https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Scripting) page. Thoughts?
Collaborator

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."

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."
Author
Collaborator

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.

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.
Author
Collaborator

Updated the wiki to reflect what we discussed here and closing this issue.

Scripting

Updated the wiki to reflect what we discussed here and closing this issue. [Scripting](https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Scripting)
Sign in to join this conversation.
No milestone
No project
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Andras/BoundlessFlowCampus2K#117
No description provided.