Dec 28, 2010 at 12:48 AM
Edited Dec 28, 2010 at 1:03 AM
It’s been about a month since I updated my private branch of Sharpbox from the latest sources from the trunk. This morning I fetched the latest version and tried to compile it.
It was quite unpleasant surprise to see bunch of warnings about missing XML comments or “Parameter 'XXX' has no matching param tag in the XML comment”
When Dirk was the only developer on the project this wasn’t the case. The project was compiling without any warnings at all.
So if you write a XML comment please make sure it includes all the method’s arguments and doesn’t cause any warnings during compilation.
We use C# for this project, aren’t? So why some of the methods have signatures similar to the following sample? This sample is actually uses two styles for the arguments naming convention.
private void FileStreamCopyCallback(long ReadByteTotal, long TotalLength, params Object data)
It should be changed to:
private void FileStreamCopyCallback(long readByteTotal, long totalLength, params object data)
It might be a good idea to read
.NET Framework 4 Guidelines for Names