I'm looking for a rather arbitrary answer, so this might more be a discussion. I'm wondering what the best practise for commenting my C# code in Visual Studio is. Right now I'm using the triple /// to generate the XML content and use Sandcastle to build a CHM or HTML file. But my problem is that I use code comments for two reasons:
- When other developers are using my code they can read the documentation, both IntelliSense and the CHM or HTML file.
- But I also use commenting as reminders to myself. So I can remember my thoughts when I come back half a year later, to some complex methods.
How can both goals be accomplished without interfering with each other, and in the same time be a quick task, not taking a lot of coding time?