Skip to main content

Questions tagged [documentation]

For questions related to the creation, usage, and improvement of software documentation

Filter by
Sorted by
Tagged with
0 votes
2 answers
121 views

Is it valid to call a configuration-format—with associated JSON-schema—a language?

Say I have a configuration file format that is very well defined; in say JSON format; with a JSON-schema defining what is allowed and how strict to be. Would it be too generous to call this a Domain ...
Samuel Marks's user avatar
5 votes
1 answer
91 views

Documenting the syntax of an existing language [closed]

I've inherited maintenance duties for a domain-specific language. This language started life forty years ago as a quick way to insert the results of mathematical operations into text documents, and ...
Mark's user avatar
  • 244
7 votes
4 answers
166 views

Enforcing doc comments in the compiler, good idea or not?

Most languages have a way of writing doc comments. Doc comments above a function, class, or struct provide a strucutred way to describe every part of the function, like this: ...
mousetail's user avatar
  • 8,339