Review main Merged

29376[CLEANUP] Fix length of comments to meet CGL

mostwanted CR +2 V +2 Easy +29 −14 updated 04/12/14, 14:18

Commit message

Review

  • Code review CR +2
    • Markus Klein +2
    • Christian Kuhn +1
  • Verified V +2
    • Markus Klein +2
    • Christian Kuhn +1

Issues 1

Files 2

Review log 12

  1. Mr. Jenkins commented on patch set 1 04/11/14, 06:54

  2. Markus Klein commented on patch set 1 04/11/14, 07:28

    For what length are you heading? Is it 80 or 120? I was under the impression that we use 120 now. At least we do that for code.
  3. mostwanted commented on patch set 1 04/11/14, 08:06

    http://docs.typo3.org/typo3cms/CodingGuidelinesReference/PhpFileFormatting/GeneralRequirementsForPhpFiles/Index.html#line-length --- quote --- Comment lines should be kept within a limit of about 80 characters (excluding tabs) as it makes them easier to read. --- /quote --- PHP_Codesniffer (used with the TYPO3 CMS sniffs) highlightens that in my IDE.
  4. Stefan Neufeind commented on patch set 1 04/11/14, 09:41

    I personally treat line-length more as a rule of thumb. If it's "very long" see if you can break it up into better readable pieces. For me it's not a hard rule. But I'm fine if you want to adjust things in a few cases here or there. We might want to rethink those rules or at least the automated codechecks in this regard.
  5. mostwanted commented on patch set 1 04/11/14, 10:58

    --- quote --- I personally treat line-length more as a rule of thumb. If it's "very long" see if you can break it up into better readable pieces. For me it's not a hard rule. But I'm fine if you want to adjust things in a few cases here or there. --- /quot --- IMO 80 characters is quite a useful length. (for me) it makes comments (much) easier to read than longer ones. for me those long comments are quite annoying when i try to read/understand core functionality, especially when i use a laptop and have more than one file opened side by side. i was thinking about fixing/shortening some more comments directly when i am reading/debugging the TYPO3 core when working on projects.
  6. Markus Klein commented on patch set 1 V +1 CR +1 04/11/14, 11:18

    Ok, since CGL obviously has the 80 chars limit, I agree to this patch.
  7. Christian Kuhn uploaded patch set 2 04/12/14, 14:04

  8. Christian Kuhn commented on patch set 2 V +1 CR +1 04/12/14, 14:08

    CGL is not a hard rule but a rule of thumb to get readable code. Following it strictly is not always beneficial. Especially, breaking the @param stuff into multiple lines (with only one or two words in the next heavily intended line) breaks read flow and does not help. Thus, I merged those to one line again and took a look if it could be shortened without information loss.
  9. Markus Klein commented on patch set 2 04/12/14, 14:10

    @Christian: We should change CGL asap!!
  10. Markus Klein voted on patch set 2 V +2 CR +2 04/12/14, 14:11

  11. Markus Klein merged patch set 3 04/12/14, 14:11

  12. Mr. Jenkins commented on patch set 2 04/12/14, 14:18