Changes between Version 1 and Version 2 of CodeDocumentation


Ignore:
Timestamp:
Jun 13, 2013, 7:44:35 AM (6 years ago)
Author:
Piotrek Koszuliński
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CodeDocumentation

    v1 v2  
    119119* Private classes by default won't be visible in the packages tree.
    120120* Good example of difference between "mixins" and "extends" is that ```CKEDITOR.event``` is mixed in various other classes and ```CKEDITOR.dom.*``` structure is based on extending parent classes.
    121 * Constructor is in fact separate documentation "instance", because it will be listed with methods. Thus, it may have its own {{{@private}}}, but it has to be placed below it, because everything before will be the part of class description. However two {{{@private}}} tags in one comment won't be accepted by JSLinter, so the doc then should be split into two comments.
     121* Constructor is in fact a separate documentation "instance", because it will be listed with methods. Thus, it may have its own {{{@private}}}, but it has to be placed below it, because everything before will be the part of class description. However two {{{@private}}} tags in one comment won't be accepted by JSLinter, so the doc then should be split into two comments.
    122122
    123123    Another conclusion is that constructor may be declared completely independently from class, what's useful when {{{CKEDITOR.tools.createClass}}} has been used.
     
    249249
    250250* Use {{{@event}}} instead of {{{@method}}} - usually you'll have to provide the name.
    251 * {{{@returns}}} isn't accepted and {{{@private}}} and {{{@static}}} may not work (haven't been tested).
     251* {{{@returns}}} isn't accepted.
    252252
    253253== Various rules ==
    254254
    255255* Always leave one blank line between textual comment and the first tag.
    256 * Separate all block (paragraphs, code samples, etc) with one blank line.
    257 * Code samples indent with at least two tabs after {{{'*'}}}.
    258 * Wrapped lines of multiline lists indent with five (default 1 + additional 4) spaces.
     256* Separate all block (paragraphs, code samples, etc.) with one blank line.
     257* Code samples indent with at least two tabs after {{{'*'}}} and remember - **no spaces**.
    259258* Always place dot {{{'.'}}} at the end of the sentence. Sentence starts with upper-case letter.
    260259* Always use single quotes for JS strings, but double quotes for cites, irony, etc. in textual comments.
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy