News for hackers. Stuff that matters.

A comment on Improved Doxygen documentation and search for C++ projects. Parent comment

Re:Improved Doxygen documentation and search for C++ projects by na85 on Thursday January 03, 2019 @01:29PM (#18817660)
I agree. Doxygen adds zero value. If I need to know what methods a class has, I have Intellisense/Roslyn for that, without even leaving emacs or my ide.

What needs to be in comments (and frequently isn't IME) is intent.

[ Parent | on HN ]
Re:Improved Doxygen documentation and search for C++ projects by aurelwu on Thursday January 03, 2019 @02:32PM (#18818387)
with Doxygen or other code generation tools you can add images which can help users understand your API more easily though. Not saying images are always helpful but there are definitely use cases. Natively adding images into comments would be a super useful feature for each IDE I think.

edit: actually there seems to be an extension for Visual Studio for example: https://marketplace.visualstudio.com/items?itemName=MsBishop...

I feel silly for never searching for that ... but then unlike with Doxygen everyone needs to have that extension

[ Parent | on HN ]