I am developing an application that contains a lot of text, as well as various modules that may or may not be included in each assembly.
For each saved project, we automatically generate a report with all the details (i.e. a description of the algorithms used in this project, etc.). Currently, we embed all the text in the form of lines in the source code, and also support different languages through po and mo files.
A good part of the system is that it is very easy to dynamically generate documents and report files. The bad point is that having a lot of text in the source code is ugly, and formatting (i.e. With html) is inconvenient, editing the text is difficult, there is no simple spell check and terrible translation.
So, the last question: is it better to embed documentation in code or write external documentation files (for example, html) for different languages and analyze them at runtime? Obviously, the main text of the software, such message boxes will remain in the code in any case.
If that matters, I am working in C ++ with wxWidgets.
source
share