Letting AI Handle the Docs: Experiments with Doxygen Comment Blocks

[mjustin 27]

The first two experiments evaluate GitHub Copilot Free and JetBrains AI Assistant in the context of maintaining Doxygen comment blocks.

It highlights how each tool integrates with the IntelliJ code editor through their respective IDE plugins. A second article will cover VS Code.

 

https://mikejustin.wordpress.com/2025/04/20/create-or-improve-software-documentation-with-an-ai-tool/

 

 

 

 

 

Edited Sunday at 12:32 AM by mjustin

[Dalija Prasnikar 1487]

Few notes.

 

First, when using free AI variants, your code will end up in the AI training data. And I wouldn't trust paid versions either. You need to be very careful that you don't give AI access to sensitive code that contains data which should not end up there. It is also very easy to do that by accident and it is prudent to run AI interactions in restricted environment like VM where you will have only non sensitive code.

 

Next, anything that AI gives out needs to be carefully reviewed by human. AI often hallucinates and sometimes those hallucinations are not as obvious. This is especially important for code which requires some detailed explanations about how it works and why or some reasoning only person who wrote the code can answer (or the reasons are written in some other documents like specifications or design). 

 

Similar goes to writing tests with AI help. 

 

One of the huge problems with AI usage, is that with time, reviewing its output becomes a mundane task and this is where mistakes can more easily creep in.

[dummzeuch 1625]

But we have Vibe Coding now!

[Rollo62 570]

On 4/20/2025 at 11:12 AM, dummzeuch said:

But we have Vibe Coding now!

Thats easy to solve, you just have to patent your prompts then