Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Code Project
  1. Home
  2. Other Discussions
  3. The Insider News
  4. Code review comment prefixes for clearer feedback

Code review comment prefixes for clearer feedback

Scheduled Pinned Locked Moved The Insider News
code-reviewcombeta-testing
4 Posts 4 Posters 0 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • K Offline
    K Offline
    Kent Sharkey
    wrote on last edited by
    #1

    Doppler[^]:

    Standardizing review terms avoids miscommunications.

    todo: Add to-do statement here

    Richard Andrew x64R M 2 Replies Last reply
    0
    • K Kent Sharkey

      Doppler[^]:

      Standardizing review terms avoids miscommunications.

      todo: Add to-do statement here

      Richard Andrew x64R Offline
      Richard Andrew x64R Offline
      Richard Andrew x64
      wrote on last edited by
      #2

      Think of it as Hungarian notation for code review comments.

      The difficult we do right away... ...the impossible takes slightly longer.

      1 Reply Last reply
      0
      • K Kent Sharkey

        Doppler[^]:

        Standardizing review terms avoids miscommunications.

        todo: Add to-do statement here

        M Offline
        M Offline
        MarkTJohnson
        wrote on last edited by
        #3

        Shouldn't you just be able to read the comments, kinda like the idea that code should be self documenting? (Which I do not ascribe to in all cases.)

        I’ve given up trying to be calm. However, I am open to feeling slightly less agitated. I’m begging you for the benefit of everyone, don’t be STUPID.

        T 1 Reply Last reply
        0
        • M MarkTJohnson

          Shouldn't you just be able to read the comments, kinda like the idea that code should be self documenting? (Which I do not ascribe to in all cases.)

          I’ve given up trying to be calm. However, I am open to feeling slightly less agitated. I’m begging you for the benefit of everyone, don’t be STUPID.

          T Offline
          T Offline
          trønderen
          wrote on last edited by
          #4

          In my student days (long ago), I was an intern in a company that was in the process of replacing their medium level (slightly below K&R C) system implementation language with a (proprietary) higher level systems language. The senior developers were eager to adopt it, for one primary reason: It was self documenting, so there was no need to waste time on writing comments.

          Religious freedom is the freedom to say that two plus two make five.

          1 Reply Last reply
          0
          Reply
          • Reply as topic
          Log in to reply
          • Oldest to Newest
          • Newest to Oldest
          • Most Votes


          • Login

          • Don't have an account? Register

          • Login or register to search.
          • First post
            Last post
          0
          • Categories
          • Recent
          • Tags
          • Popular
          • World
          • Users
          • Groups