Quote:
Originally Posted by Pierce28
That looks rather impressive. Not having seen your code, I want remind you to make sure that you write up good documentation on how to implement it if your intention is for others to place it in their programs.
Remember, don't assume that everyone understands that "gtkbd2ppot()" stands for "Get the keyboard to pop out". :-P
|
Definitely agreed. If you use XML comments (type /// on the line before each function and class and fill in the template it gives you), then turn on the relevant option in your project's properties, you'll get an XML file with your DLL every time you compile. Then, if you distribute the XML file with the DLL, Visual Studio will pick it up and use it to show documentation in IntelliSense and Object Browser.
Also, .NET has some specific naming conventions that help make your API look more consistent and easy to understand. Classes and public methods/properties/fields should be named in UpperCamelCase, while function arguments should use lowerCamelCase. Two letter acronyms should be capitalised (e.g. IO) but all other abbreviations and acronyms should be treated like normal words (e.g. Http, Xna).
