![]() Basically the same thing I see when I press dot key in Visual Studio and intellisense box comes up. But what I get as a first hit in MSDN search is a detailed method description of string. All I want to know is that somewhere there is a class named MemoryMappedViewStream derived from UnmanagedMemoryStream (which is derived from Stream) that meets my requirements. What I need is a kind of guidebook to help me find the right one based on context of my application. Let’s say a component I’m going to use requires a Stream as input. NET with at least 3 levels of inheritance depth. ![]() … be about problem solving, not restating the facts.Īs an example, there are over 20 Stream classes in.They are easy to edit – if you see an outdated or wrong post, go ahead and fix it! Wiki like public knowledge repositories or Q&A platforms like Stackoverflow are good examples. … cover only aspects which cannot be easily derived from code, interface or intellisense.That’s why it’s important to have a good documentation. While reading it, we understand that all the facts that are described we’ve already discovered ourselves, but the point we are stumbling over is not covered at all. Usually, we come back to documentation after we get stuck. And finally, to be honest, who reads the documentation first? No one does.Reading such a documentation can be misleading and frustrating. ![]() ![]() Any documentation tends to became outdated.Ideally, it is designed the way that does not allow wrong usage. Only the code tells the truth ( /wiki/index.php/Only_the_Code_Tells_the_Truth) The good component expresses its intended way of usage through good structure, expressive naming.I hate overdocumented software components and frameworks. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |