Results 1 to 5 of 5

Thread: [RESOLVED] Is it wise to leave code comments in app?

  1. #1

    Thread Starter
    Addicted Member
    Join Date
    Feb 2009
    Location
    Uk
    Posts
    157

    Resolved [RESOLVED] Is it wise to leave code comments in app?

    Just wondering if its wise to leave code comments in your finished app or best to clear them out?
    Just wondering if they would make a crackers job easier if they were in place?

  2. #2
    Next Of Kin baja_yu's Avatar
    Join Date
    Aug 2002
    Location
    /dev/root
    Posts
    5,989

    Re: Is it wise to leave code comments in app?

    Comments are not compiled with the code. The compiler skips them as if they are not there at all. So the unwise thing would be to remove them.

  3. #3
    Super Moderator si_the_geek's Avatar
    Join Date
    Jul 2002
    Location
    Bristol, UK
    Posts
    41,974

    Re: Is it wise to leave code comments in app?

    It depends on which language you are using, but assuming it is one that creates executable files, leave them in - because comments only exist in the code files, they do not get compiled into the executable.

  4. #4

    Thread Starter
    Addicted Member
    Join Date
    Feb 2009
    Location
    Uk
    Posts
    157

    Re: Is it wise to leave code comments in app?

    Oh didnt realise that, its good to know!
    Thanks guys

  5. #5
    PowerPoster RhinoBull's Avatar
    Join Date
    Mar 2004
    Location
    New Amsterdam
    Posts
    24,132

    Re: [RESOLVED] Is it wise to leave code comments in app?

    You do want to leave all comments in your app - although they are not compiled each comment you (or any of your colleagues) made will help in the future to better (and much quicker too) understand what the entire app or specific piece of code does.
    Programs without comments are very difficult to maintain - we often forget what we did yesterday; would you remember what was in your mind a year ago?
    And you want to comment as much as you think it is necessary - functions/procedures/etc need so description about what it does, expected results, known issues (if any), etc...
    You and your colleagues will appreciate this at some later time.

    Regards.

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  



Click Here to Expand Forum to Full Width