添加源代码文档

您可以向代码添加注释，以便为函数、类和方法生成文档。IDE 可识别使用 Doxygen 语法的注释，并自动生成文档。还可以自动生成注释块来记录注释下方的函数。

1. 在 quote.cc 文件中，将光标置于行 int readNumberOf(const char* item, int min, int max) { 上面的行上。

2. 键入一个正斜杠和两个星号 (/**)，然后按 Enter 键。编辑器会为 readNumberOf 类插入一条 Doxygen 格式的注释。

   

3. 向每个 @param 行添加一些描述性文本，然后保存文件。

4. 单击 readNumberOf 类将其以黄色突出显示，然后单击右侧的其中一个标记实例跳到使用该类的某个位置。

   

5. 单击所跳到的行中的 readNumberOf 类，然后按 Ctrl + Shift + 空格键显示刚才为这些参数添加的文档。

   

6. 单击文件中的任何其他地方关闭文档窗口，然后再次单击 readNumberOf 类。

7. 选择 "Source"（源）> "Show documentation"（显示文档）再次为该类打开文档窗口。