Snygga kommentarer

Tjena,
Här får ni posta olika sätt ni skriver kommentarer på. Jag vill ha fina snygga kommentarsätt ;)

det beror på vad det är för kommentarer

i koden så blir det oftast // medans om jag skall skriva definitioner för sidan så blir det mer anvancerat

netfeed skrev:

det beror på vad det är för kommentarer

i koden så blir det oftast // medans om jag skall skriva definitioner för sidan så blir det mer anvancerat

Hur ser en mer avancerad ut?

Är det längre mer förklarande så brukar jag använda

/************************
 * Detta är en fin text *
 ************************/

Annars brukar det bli den klassiska

// Min kommentar här

Några sätt:

# Kommentar på en rad

// Kommentar på resten av raden

/* kommentar
som sträcker sig
över flera
rader */

Rätta mig om ja har fel ngn.. :)

# kan användas på resten av raden också.. ;)

/* Jag gör så här ibland också */

Snyggast på långa kommentarer (enligt mig):

/**
 * Kommentar
 * ...
 * osv
*/

Så här kan vara ganska snyggt?

# ======================================
#  Programmet X
# ======================================
#  Detta program gör en del saker.
#
#  Skapat 2002-10-12 av Inge Nalls
#
# ======================================

   #--- Deklarera variabler
   $variabel="1";

   #--- Hämta QueryString
   $tmpQuery = $QUERYSTRING;

   # -----------------------------------------
   #  Kolla om filen finns
   # -----------------------------------------
   if (file_exists("fil.typ"))
   {
      #-- Öppna filen
      fp=fopen("fil.typ");

      #-- Hämta värde
      $filtext=fgets(fp,4096);

      #-- Stäng filen
      fclose(fp);
   }

Jag "nivåindelar" ibland kommentarerna genom att använda olika antal streck efter #. Eller inget streck alls...

att använda # till att kommentera förvirrar bara. iaf mig.
jag har förknippat #-kommentarer så stark med perl så det skulle kännas konstig att använda det i php.

För mig är det viktigt att kommentarerna syns tydligt och skiljer sig bra från övrig kod. Det tycker jag mitt exempel gör.
Jag kodar en del ASP också (måste tyvärr!) och där tycker jag kommentarstecknet (') syns för dåligt.

Jag vet att # inte rekommenderas som kommentarstecken i PHP, men jag är fräck nog att ignorera den rekommendationen! ;)
Och så har jag ju ingen Perl-bakgrund, så jag slipper dessutom förvirringen. :)

Tack och lov är ju smaken som baken - delad! Och det viktigaste är ju ändå att man kommenterar över huvud taget!