So added some notes to the header files page: http://wiki.services.openoffice.org/wiki/Cpp_Coding_Standards/Header_Files
One thing that seems to surprise people now and then is that you don't actually require the definition of a type when declaring a function passing it by value: void doSomething(Foo aFoo); So my summary is that you should only #include superclass and data member definitions in a header file. Anything I'm missing? Kai On 12 Dec 2006 16:13:22 +0100, Thorsten Behrens <[EMAIL PROTECTED]> wrote:
Hi folks, complementing Nikolai's GullFOSS entry http://blogs.sun.com/GullFOSS/entry/quality_and_coding_standards I'd like to draw your attention to a revamped version of the OOo coding guidelines (with the old one getting of age - ~4 years). We (Nikolai, Matthias H. and me) thought an update and a move to the Wiki might be in order, and doing that, we went and scanned/re-read larger chunks of literature about the topic (Lakos, Sutter/Alexandrescu, Fowler, to name a few) - and then condensed the material into 19 separate topic areas, with a handful of rules each. Compared to the old guidelines, the plan is to make this one significantly easier to digest & use in day-to-day coding (as people can start small, like using one or two topic areas in the beginning). If you're a C++ coder - please give it a try: http://wiki.services.openoffice.org/wiki/Cpp_Coding_Standards Got an impression? Great. Here comes the catch: we need your input to improve this further, in a very broad sense. We need more background information, examples, and maybe external links on the rule details pages (each rule is basically just a tagline, with a one-sentence summary of the content). We need your opinion about relevance (or irrelevance) of the rules. And we need to know if (by your opinion), we've forgotten an important one. Just use the wiki discussion pages of the respective rules, or simply add your content. Why should you bother? Well, because OOo is complex enough by itself, and having a bit of guidance in the land of C++ should be helpful to almost everybody, especially for people new to the project. At the end of the day, getting into the habit of checking your code against (some subset) of coding rules might even make you spot a few other bugs here and there - improving the quality of code newly introduced to OOo. Thanks for listening, and eagerly waiting for your feedback! Cheers, -- Thorsten --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
-- Kai Backman, Software Engineer, [EMAIL PROTECTED] --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
