В этой документации используются следующие соглашения об именах и форматировании.
Код находится в<fixedwidthfont>и выделяется синтаксисом в цвете.
Заменимый текст, который вам нужно будет предоставить, находится в<italics>.
Свободные функции выполняются в<codefont>, а затем<()>, как в<free_function()>.
Если имя относится к шаблону класса, оно указывается следующим образом:<class_template<>>; то есть оно находится в шрифте кода, а за его именем следует<<>>, чтобы указать, что это шаблон класса.
Если имя относится к функциональному макросу, оно указывается следующим образом:<MACRO()>; то есть, он является верхним шрифтом кода, а за его именем следует<()>, чтобы указать, что он является функциональным макросом. Объектоподобные макросы появляются без следа<()>.
Имена, которые относятся кпонятиямв общем смысле программирования, указаны в CamelCase.
Note
Кроме того, такие заметки, как эта, указывают несущественную информацию, которая обеспечивает дополнительный фон или обоснование.
Наконец, вы можете мысленно добавить следующие фрагменты кода в этот документ:
// Include all of Pool files#include<boost/pool.hpp>
Статья Documentation Naming and Formatting Conventions раздела Boost.Pool Introduction and Overview может быть полезна для разработчиков на c++ и boost.
![[Note]](/img/note.png)
