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


Thanks for the translations, and thanks for pushing! A few notes:

 /*-----------------------------------------------------------------------
-    Beschreibung: Uebernahme der aktualisierten Werte aus dem Set
+    Description: acquisition of the updates values from the set
  -----------------------------------------------------------------------*/

I think that while editing comments like these we want to cut down the excessive ASCII graphics, 
too. Or do we? Also, the word "Description:" here is pointless, what else are comments if not 
descriptive?

I am not sure if there is any consensus here, but personally, if I edit a comment that is formatted 
like that, at the same time I drop the ASCII graphics and end up with simply:

// Acquisition of the updates values from the set

Thus saving two lines of vertical space, a very scarce resource.

+        // Orientation and Size from PageItem
+        // set left and right border
+    // evaluate header-attributes

Just nitpicking, but do try to avoid German capitalization of Nouns and overuse of 
hyphenized-words. Use consistent capitalization of the first word of a comment that isn't a 
complete sentence, either always just lower case or always initial capital. (Comments that are one 
or several complete sentences should always be properly capitalized.)

 // PRIVATE METHODES ------------------------------------------------------
 /*------------------------------------------------------------------------

More ASCII graphics that can be removed, and the " PRIVATE METHODES" should either be lowercased 
and its spelling corrected (no e in methods). Or just dropped, why would this source file need such 
a comment telling that private methods follow? Is it even true?

+    Description: ctor
+    Description:  static data
+    Description:     Now as TabPage
+ Description:        Initialisation

Fairly useless comments.  I would just remove them. Constructors are recognizable by their 
signature, static data is also obvious, "Now as TabPage" doesn't really tell much without knowledge 
of the history of the code anyway, and it is very obvious that a method called "Init" does 
initialisation.

--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.