You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the event that this code will be used by other people other than me, it'd be nice to comment certain things about the project.
What all of the tools are and how to use them.
What each project is for.
[Ties in with the first point] How to develop certain parts of the projects. E.G how to refresh the EF Model, how to create a new editor in DataManager/Maintainer, how to use the tooling to generate certain parts of the projects, etc.
Use a documentation generator for all library projects, as this is vital for other people being able to easily sift through library code. For D-based projects, this can be done using ddoc(built in documentation tool), ddox(external tool that produces much nicer documentation than ddoc), or ddox-based tools like scod for even better looking documentation. For everything else, it's probably best to use something like Doxygen, which can parse most major languages and produces decent looking documentation.
The text was updated successfully, but these errors were encountered:
In the event that this code will be used by other people other than me, it'd be nice to comment certain things about the project.
What all of the tools are and how to use them.
What each project is for.
[Ties in with the first point] How to develop certain parts of the projects. E.G how to refresh the EF Model, how to create a new editor in DataManager/Maintainer, how to use the tooling to generate certain parts of the projects, etc.
Use a documentation generator for all library projects, as this is vital for other people being able to easily sift through library code. For D-based projects, this can be done using ddoc(built in documentation tool), ddox(external tool that produces much nicer documentation than ddoc), or ddox-based tools like scod for even better looking documentation. For everything else, it's probably best to use something like Doxygen, which can parse most major languages and produces decent looking documentation.
The text was updated successfully, but these errors were encountered: