Date: prev next · Thread: first prev next last
2011 Archives by date, by thread · List index


1.) I think I'll try to open a bug report and attach the complete
patch to that, as suggested by Norbert in another reply.

That's good, yes.

2.) Regarding the whitspaces I think most of them I made due to the
commit rule on tabs.

Hmm, the commit hook cares only that you don't introduce any *new* TAB characters, it shouldn't be 
alarmed if lines that you don't touch continue to have TABs. Do you really see different behaviour?

(I think at some early stage we did have over-eager commit hooks that did check whole files being 
committed for leading TABs. But that has changed some time ago.)

3.) On Removing boilerplate comments: I have been very restrictive in
removing any comments. Removing them can maybe be done in a second
step and by someone how is more knowable about the code than I?

I don't think you need to be that careful here.  I think I can say with confidence that boilerplate 
comments like the these:

/*************************************************************************
|*
|*        RscTop::Size()
|*
|*        Beschreibung
|*        Ersterstellung        MM 29.10.91
|*        Letzte Aenderung      MM 29.10.91
|*
*************************************************************************/

are universally loathed by all developers. They don't give any useful information at all and just 
take up space in your editor window that could be more usefully used to show more context of the 
code you are looking at.

Obviously, the "last change" dates, when present, in such comments are hardly reliable. It is very 
likely that people who have changed code in a method with such a comment have not edited the date. 
And why would they had edited it, that's what revision control is useful for, to keep change 
history.

If/when we in LibreOffice introduce a policy to have comments with formal metadata for newly 
written or heavily changed code, I think the consensus is that we will use Doxygen format, not any 
home-brewed format like the above.

--tml



Context


Privacy Policy | Impressum (Legal Info) | Copyright information: Unless otherwise specified, all text and images on this website are licensed under the Creative Commons Attribution-Share Alike 3.0 License. This does not include the source code of LibreOffice, which is licensed under the Mozilla Public License (MPLv2). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.