XML Documentation Comments not working.

Hi there.

After struggling a bit with XML Documentation Comments earlier today, I just thought I would leave this comment, in case someone else has similar problems.

One of the Projects in my VB.NET Solution seemed unwilling to let me write XML Documentation in my code. When tapping ''' on the line directly above a method declaration, nothing would happen. The project consisted of modules and classes only(no forms), so I initially thought that had something to do with it.

Later I found that under project properties and the Compile tab, the "Generate XML documentation file" checkbox was left unchecked. Checking this instantly allowed me to place the comments normally. After doing some testing, I also found that Creating an Empty project leaves the checkbox unchecked, while creating a Windows Application automatically checks it.

I hope this helps someone.




Answer this question

XML Documentation Comments not working.

  • StarPilot

    Thank you very much!

    Thought it was some plug-in problem.


  • 2162

    The vb compilier hotfix listed at the top of the forum fixed a memory leak with xml comments. You might want to call microsoft there might be a hotfix for your problem.

  • XML Documentation Comments not working.