Source Code Comment Flags

  • indicates code that has been temporarily disabled in order to get a file to compile. use very sparingly!
    //&&&
  • indicates places in the code where the person doing the porting wasn't completely certain about the right thing to do, and made a best guess. If these guesses are incorrect, there could be problems after the code is running, and these comments are the first place to look for solutions to weird problems.
    //@@@
  • indicates an inline port-related comment. Use these to show relevant research into a problem you have investigated, but either can't or don't have time to solve yourself, so whoever follows doesn't have to repeat the legwork. These can also be used for other general port-related comments.
    //###
  • a traditional comment flag that can mean either TODO or “this code is probably crap.” These are old, and likely of no real concern to us during the port.
    //!!!
  • find very-critical debug messages with the commands - (list files:)
    grep -lir "@@@" * | egrep "cpp$"

    and (list lines:)

     grep -nir "@@@" *
 
 
dev/comment_codes.txt · Last modified: 2013/07/02 12:55 (external edit)
Recent changes RSS feed Creative Commons License Valid XHTML 1.0 Valid CSS Driven by DokuWiki