[dlang.org] [D-Programming-Language/dlang.org] d1147a: Remove section in style guide about comments.

GitHub noreply at github.com
Fri Sep 20 15:50:19 PDT 2013


  Branch: refs/heads/master
  Home:   https://github.com/D-Programming-Language/dlang.org
  Commit: d1147aedf7289450deee9130c81eefc56d1d7e60
      https://github.com/D-Programming-Language/dlang.org/commit/d1147aedf7289450deee9130c81eefc56d1d7e60
  Author: jmdavis <jmdavisProg at gmx.com>
  Date:   2013-09-19 (Thu, 19 Sep 2013)

  Changed paths:
    M dstyle.dd

  Log Message:
  -----------
  Remove section in style guide about comments.

We don't really follow the guidelines on comments, and some of them are
arguably outright bad (e.g. using version(none) does not play nicely
with syntax highlighting, since the code appears to be active unlike
when it's commented out). There was some agreement on this when I
brought it up in the past, but for the most part, no one even responded
to attempted discussions on it. But since we don't really follow the
comment guideliness, and they _are_ bad in at least one case, I think
that it's far better to just remove them. The only case where we even
get any dispute about comments at this point is whether ddoc comments
should use /++ +/ or /** */ and the comment guidelines don't discuss
that.


  Commit: 0c98acdb68ddc72a64ba94b6b58cfb0aca877bc5
      https://github.com/D-Programming-Language/dlang.org/commit/0c98acdb68ddc72a64ba94b6b58cfb0aca877bc5
  Author: Andrej Mitrovic <andrej.mitrovich at gmail.com>
  Date:   2013-09-20 (Fri, 20 Sep 2013)

  Changed paths:
    M dstyle.dd

  Log Message:
  -----------
  Merge pull request #381 from jmdavis/comments

Remove section in style guide about comments.


Compare: https://github.com/D-Programming-Language/dlang.org/compare/f03501e1dbe5...0c98acdb68dd


More information about the dlang.org mailing list