c# Programming Glossary: documenting
Avoiding the woes of Invoke/BeginInvoke in cross-thread WinForm event handling? http://stackoverflow.com/questions/1364116/avoiding-the-woes-of-invoke-begininvoke-in-cross-thread-winform-event-handling Sorry to keep dragging this on however I thought it worth documenting here. I've managed to solve most of the problems above and I'm..
C# - How do I access the WLAN signal strength and others? http://stackoverflow.com/questions/1686715/c-sharp-how-do-i-access-the-wlan-signal-strength-and-others strength and others Many scientists have published papers documenting how devices connected via WLAN can be tracked by measuring its..
Why C# doesn't implement indexed properties? http://stackoverflow.com/questions/2806894/why-c-sharp-doesnt-implement-indexed-properties worth the cost of designing implementing testing and documenting it . But still I'd like a better explanation... I was reading.. list. Every minute we spend designing implementing testing documenting or maintaining nice feature X is a minute we can't spend on..
Is Using Tuples in my .NET 4.0 Code a Poor Design Decision? http://stackoverflow.com/questions/3017352/is-using-tuples-in-my-net-4-0-code-a-poor-design-decision choice To me it seems like less clutter but not as self documenting and clean. Meaning that with the type ResultType it is very..
Static Class Vs. Class with private constructor and all static properties and methods? http://stackoverflow.com/questions/323022/static-class-vs-class-with-private-constructor-and-all-static-properties-and-me I would add that defining a class as static is self documenting code. Users of your library will know that this class should..
Why are extension methods only allowed in non-nested, non-generic static class? http://stackoverflow.com/questions/3930335/why-are-extension-methods-only-allowed-in-non-nested-non-generic-static-class the considerable costs of designing implementing testing documenting and maintaining the feature. Basically extension methods were..
How to document thrown exceptions in c#/.net http://stackoverflow.com/questions/461306/how-to-document-thrown-exceptions-in-c-net also may throw DivideByZeroException I know the markup for documenting exceptions is exception cref SomeException when things go wrong... to document these exceptions You'd look pretty foolish documenting OOMs on every single method that new s up an object. The ones.. and can do something about are the ones you should be documenting and wrapping. You can find some more guidelines on exception..
Why does (does it really?) List<T> implement all these interfaces, not just IList<T>? http://stackoverflow.com/questions/4817369/why-does-does-it-really-listt-implement-all-these-interfaces-not-just-ilis doing so makes the code easier to understand and more self documenting. Or perhaps the developer wrote the code as interface I1 interface..
How do I create a HashCode in .net (c#) for a string that is safe to store in a database? http://stackoverflow.com/questions/5154970/how-do-i-create-a-hashcode-in-net-c-for-a-string-that-is-safe-to-store-in-a to version... like string.GetHashCode . Writing and documenting your own hash like this is a bit like saying This sensitive..
Xml string in a C# summary comment http://stackoverflow.com/questions/607094/xml-string-in-a-c-sharp-summary-comment string in a C# summary comment I'm documenting a few methods I wrote in C# that deal with parsing tokens. Due..
What are some good .NET code documentation tools? http://stackoverflow.com/questions/665925/what-are-some-good-net-code-documentation-tools your code. It will look at your names of the items you are documenting and try to figure out a good starting description. It is a useful.. description. It is a useful tool to start consistently documenting your code. I don't the names off the top of my head but then..
WPF Styles/Template inheritance http://stackoverflow.com/questions/7070421/wpf-styles-template-inheritance
Ways to synchronize interface and implementation comments in C# http://stackoverflow.com/questions/824007/ways-to-synchronize-interface-and-implementation-comments-in-c-sharp between an interface and its implementation I'm currently documenting them both and wouldn't like to manually keep them in sync. UPDATE.. and implemented classes. I've actually done it myself in documenting one of my libraries and I haven't see any problems whatsoever...
|