Doxygen評論私人會員和免費功能？

Question

我應該使用Doxygen評論私人會員和免費功能？我來自Java世界，並且我從未將Javadoc添加爲私有成員。這是C++世界中可接受的做法嗎？

Answer 1

我會說這幾乎是獨立於語言的問題。你記錄你想要記錄的成員。

Answer 2

取決於文檔目標受衆。如果它是公開發布的，那麼不，他們不需要知道私有和內部變量。

如果是內部使用，那麼他們肯定需要知道私有變量和自由函數的用法。

Answer 3

您可以記錄私人功能 - 我們可以使用@internal來提供公共和開發者文檔。

我們還使用私有實現實踐，其中實現對用戶是隱藏的。