Documenting Changes in Scripts

Discussion in 'General Modification' started by Cerulean the Blue, Sep 7, 2005.

Remove all ads!
  1. Cerulean the Blue

    Cerulean the Blue Blue Meanie Veteran

    Joined:
    Apr 23, 2005
    Messages:
    1,962
    Likes Received:
    0
    Hi all. I hope I'm not being too much of a PITA, but I would like to propose that all modders start using comments (i.e. # (text)) to document any changes or additions to scripts. As an example, in my Random Encounter fix I left in the original code in comment form (and put in a line or two indicating it was the original code) and then used comments to show that the new code I put in was new and written by me. This might seem like a lot of extra work, but it will be a big boon to other modders, and possibly save them a lot of work in the process.
     
  2. Agetian

    Agetian Attorney General Administrator

    Joined:
    Aug 14, 2004
    Messages:
    2,526
    Likes Received:
    0
    I'd like to say that this is generally considered a very good programming practice. The use of comments makes it considerably easier for yourself and for other modders who may be viewing and willing to update your scripts to understand what your script is doing. So, I join up with Cerulean the Blue in this request to all modders. Python uses the following format for comments:

    # <comment>

    - Agetian
     
Our Host!