The Community Forums

Interact with an entire community of cPanel & WHM users!
  1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

Adding comments to language files

Discussion in 'cPanel Developers' started by sirbrent, Jun 17, 2009.

  1. sirbrent

    sirbrent Well-Known Member

    Joined:
    Sep 30, 2008
    Messages:
    98
    Likes Received:
    1
    Trophy Points:
    8
    Hello,

    I am adding some strings to the a cPanel theme language file (i.e., english-utf8)
    and am wondering what the proper way to add comments to this file would be.

    Thanks so much.
     
  2. cPanelDavidG

    cPanelDavidG Technical Product Specialist

    Joined:
    Nov 29, 2006
    Messages:
    11,279
    Likes Received:
    8
    Trophy Points:
    38
    Location:
    Houston, TX
    cPanel Access Level:
    Root Administrator
    We use // or # at the beginning of a line to insert a comment on that line of the language file.

    For example:

    Code:
    // My comment goes here
    DavidG=Text value for this language key goes here
    
    However, the following is not recommended in language files:

    Code:
    DavidG=Text value for this language key goes here // This text may not be interpreted as a comment
     
    #2 cPanelDavidG, Jun 17, 2009
    Last edited: Jun 17, 2009
  3. sirbrent

    sirbrent Well-Known Member

    Joined:
    Sep 30, 2008
    Messages:
    98
    Likes Received:
    1
    Trophy Points:
    8
    Thank you!
     
Loading...

Share This Page