KnowledgeHub
Questions
Tags
Users
Search
Alex Rivera
|
Logout
Edit Question
Title
Body
Is there a convention for documenting shell scripts' parameters? For example: #!/usr/bin/env bash # <description> # # Usage: # $ ./myScript param1 [param2] # * param1: <description> # * param2: <description> A few things I don't like about this particular template: the script's file name ( myScript ) appears within the file itself parameter description seems weird the leading space before $ is visually useful, but can lead to confusion in languages with block comments, causing some validation tools to complain about mixed/inconsisent indentation (e.g. spaces in this block, tabs for code - provided one prefers tabs, of course) Are there any guidelines on this?
Tags (comma-separated)
Save Edits
Cancel