search

lecode-official / command-line-parser

A simple and light-weight parser for command line arguments, which makes it possible to access parameters from the command line via well-defined .NET data structures.
MIT License
3 stars 4 forks source link

There should be comprehensive documentation for the command line parser #9

Open lecode-official opened 6 years ago

lecode-official commented 6 years ago

Before the next version of the command line parser is shipped to NuGet, a comprehensive documentation should be created. At first it would be sufficient to explain how to use the command line parser API and show some common scenarios. Anything that goes deeper such as custom value converters, API documentation, etc. maybe added post launch.

lecode-official commented 6 years ago

The documentation should probably start with a short introduction to the project (including the hint for older users that the project was completely rewritten, and why it was that way). Then a short introduction to command line argument syntax should follow. Finally some simple instructions for the setup of a new project should be created. Then, step by step, positional arguments, named arguments, and flag arguments should be introduced. Finally some more complex data types such as collections should be introduced. Then an advanced section should show some common scenarios (e.g. using a VerbosityLevel enumeration to support -vvv-style arguments. In this section the conflict resolution mechanism should be explained. Maybe at the very end the value conversion mechanism may be explained and how to use custom value convertes.

lecode-official commented 6 years ago

Each of the steps explained in the documentation should be a self-contained sample, that should be in a samples directory.