Hi everyone, DbLinq has too few documentation ( http://www.ohloh.net/projects/dblinq/analyses/latest tells us that it is below 20%, and it currently includes the licence comments), and this may lead to maintainance problems.
So every contributor must ensure that AT LEAST: - the class and methods have an XML DOC banner, with at least a small sentence (that's often enough). - when writing complex methods, explain the algorithm. For people who want to do more (probably == no one :)), they can also add context and examples. Spring.NET, for example has a lot of samples in code (even if a human being still can not work on it, because of complexity...). We should target a minimum of 30% of comments in code. Since we're lazy (so we are smart, aren't we?), there are good tools to help. Stefan Klinger told me about GhostDoc ( http://www.roland-weigelt.de/ghostdoc/). It is a great tool to document code in XML DOC format. It goes beyond Visual Studio and by the method and parameters name, guesses the method purpose and creates a small documentation (well, most of the time). If you implement and interface, it also takes this interface documentation down to the implementation. And this is where we must be very careful: Microsoft .NET documentation is copyrighted, so we can not include it as is in DbLinq. So when using GhostDoc, please ensure that you're not copying MS documentation. Pascal. jabber/gtalk: [EMAIL PROTECTED] msn: [EMAIL PROTECTED] --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "DbLinq" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/dblinq?hl=en -~----------~----~----~----~------~----~------~--~---
