I recently switched the "Xml Document" checkbox on Csla on and it produces over 50 documentation errors when compiled. It would be nice to get these fixed as the docs are great for developers new to the Csla. Most of the time it is simply a matter of a case difference or a parameter has been renamed but the comments not updated. I could correct them myself but that creates problems when new versions are released.
Thanks.
John.
Thanks John,
I know the comments need some work, but I've been putting off tackling that until there's a workable version of ndoc around. That way I can spend some serious time not only getting rid of the warnings in VS, but also making the results look good in a chm file.
The time commitment is pretty big either way, since I need to do this in a way that the VB and C# comments are all in sync. I actually wrote a utility that monitors the clipboard so I can write comments in VB (because in VS 2005 the XML comment intellisense is better in VB) and then copy-paste the comments into the C# project, with this little utility doing a VB->C# transform as the data passed through the clipboard.
But even so, it is a lot of time.. And so I'd rather not go through the comments two more times, but rather just one more time and solve both the compiler warnings and ndoc issues in the same pass.
Copyright (c) Marimer LLC