Какое соглашение о комментариях есть // [<module> _include ... //]?

Question

Учебное пособие boost :: property_tree включает в себя очевидное соглашение о комментариях:

//[debug_settings_includes
#include ...
//]
//[debug_settings_data
struct debug_settings {...};
//]
//[debug_settings_load
void debug_settings::load(const std::string &filename) {...}
//]
//[debug_settings_save
void debug_settings::save(const std::string &filename) {...}
//]
int main() {...}

Это просто соглашение в режиме emacs org-mode? Существуют ли инструменты, которые используют это соглашение? Будет ли принятие и принятие его исполнит мою жизнь?

Answer 1

Похоже, что это часть генерации документации.

например, если вы видите необработанный источник учебной документации , вы увидите, что он содержит такие строки, как

First we need some includes:

[debug_settings_includes]

To store the logging configuration in the program we create a debug_settings
structure:

[debug_settings_data]

Линии, заключенные в квадратные скобки, имеют соответствующие разделы в исходном файле примера .

А при просмотре самой документации мы видим, что эти "ключевые слова" "были заменены кодом из исходного файла.

Для получения дополнительной информации прочитайте документацию по быстрой установке Boost .