HTML、CSS、PHP、JSにコメントを追加する方法

「コメント」とは、ウェブブラウザでは表示されないHTML、XML、CSS、JS、その他のプログラミング言語内のコードまたはテキストの事です。 これはコードの内容に対して何らかのメモ書きを加えたり、コード情報を一時的に無効化したり、あるいはコード作成者からのフィードバックをするために用います。

HTMLコメント

あとで必要となる可能性のある要素を削除せずに、一時的にコメントとして残したり、デバックの際にHTML内にメモ書きをする際に使用します。

例:コメントの開始タグ「<!–」をコードの前に置き、終了タグ「–>」をコードの後に置きます。

&lt;!-- {%FOOTER_LINK} --&gt;
&lt;/div&gt;
&lt;/div&gt;
&lt;/footer&gt;
&lt;/body&gt;
&lt;/html&gt;

CSSコメント

CSSのブロック要素を有効化または無効化したり、そのコードがどんな要素なのか説明書き加える際に使用します。これは「/*」から始めて、「*/」で終わります。

例:

/* 全体の構成---------------------------------------- */
.main {
    margin:0 auto;
    width:940px;
    position:relative;
/*
h2 {
    font-size:26px;
    line-height:28px;
}
*/

PHPコメント

追加できるコメントには2種類あります。

  1. 1行コメント:複雑なコードに対して説明書きを加える際に使用したり、PHPのコードを部分的に、無効化する時にに使用します。使用するときは、コードの前に「//」か「#」を追加します。
    例:

    //My comment goes here
    #define('TABLE_HEADING_WRITABLE', 'Writable');
    
  2. 複数行コメント:コードの大部分を無効にしたり、または複数行のコメントを加える際に使用します。使用するときは、コードの前に「/*」を、コードの後に「*/」を追加します。
    例:

    /*$Id$
    osCommerce, Open Source E-Commerce Solutions
    
    http://www.oscommerce.com
    
    Copyright (c) 2010 osCommerce
    Released under the GNU General Public License
    */
    

Javascriptコメント

追加できるコメントには2種類あります。

  1. 1行コメント:コードの一段落を無効にしたり、ちょっとした注意書きを加える際に使用します。使用するときは、コードやテキストの前に「//」を追加します。「//」の右側にあるテキストが全て無効になります。例:
    //verify if value is in the array
      function in_array(value, array)
      {
    for (var i in array)
    if (array[i] == value)
    return true;
    return false;
    }
    
  2. 複数行コメント:コードの大部分を無効にしたり、または複数行のコメントを加える際に使用します。使用するときは、コードの前に「/*」を、コードの後に「*/」を追加します。例:
    /*function in_array(value, array){
    for (var i in array)
        if (array[i] == value)
        return true;
            return false;}*/
    &lt;/script&gt;
    

Comments are closed.