Entries tagged as comment

2008-02-27 Codeteile mit Kommentaren schnell ein- und ausschalten

English Version also available

Ich dachte eigentlich den Trick kennt schon jeder, da ich ihn selbst seit vielen Jahren immer wieder nutze. Scheinbar aber nicht.

Daher hier ein kleiner Trick der mir beim täglichen coden immer wieder gute Dienste leistet. Da ich keinen expliziten Namen dafür kennen nenne ich das mal "Schalterkommentare".

Beim arbeiten an Programmcode kommt es sehr häufig vor, dass man Codeteile regelmäßig ein- und ausschalten muss.

Dazu kann man die gewünschten Zeilen mit einem // oder einem /**/ Kommentar immer wieder ein- und auskommentieren.

Bei längeren Codepassagen kann das schon mal etwas dauern und bei häufigen umschalten etwas/ziemlich nerven.

Fasst man den Codeblock aber in einen "Schalterkommentar" ein kann man ihn nur durch das ändern eines einzigen Zeichen komplett aus dem Verkehr nehmen und wieder zurück.

Schalterkommentare sind eine Mischung aus Einzeiligen und Mehrzeiligen Kommentaren. Eingeleitet werden sie mit: //* und mit // */ wieder beendet. Code der so eingefasst ist, ist voll funktionsfähig. Entfernt man nun den einen der / vom einleitenden Kommentar wird der gesamte Block deaktiviert.

Hier der Beispielcode:

Kommentar aktiv:


demo = {
    /*
    someTest.Javascript();
    toDemonstrate = 'how Easy';
    // */

    it.is('to make Code appear');
    and = ['disappear','again'];
    this.isVeryUseful('indeed');
};
 
Kommentar inaktiv:

demo = {
    //*
    someTest.Javascript();
    toDemonstrate = 'how Easy';
    // */
    it.is('to make Code appear');
    and = ['disappear','again'];
    this.isVeryUseful('indeed');
};
 

CSS fällt wegen der fehlenden Unterstützung für // Kommentare leider raus, Javascript, PHP und viele andere kommen damit aber wunderbar zurecht.

Update:
Mein Kollege Steve Webster brachte mich auf die logische Alternative fuer CSS:

Kommentar aktiv:


.test{
    border:1px solid red;
    /*/
    background-color:blue;
    /**/

    margin:1em;
}
 
Kommentar inaktiv:

.test{
    border:1px solid red;
    /**/
    background-color:blue;
    /**/
    margin:1em;
}
 

2008-02-27 Switch comments - enabling and disabling Codeparts fast and easy

Deutsche Version auch verfügbar

I always thought everybody knows this little Trick already because I'm using this for many years now. Apparently not.

So here's the Hint that helps a lot during everyday coding. Because I don't know if there's a proper naming already I call it "Switch Comments".

While working on Code it happens a lot you need to switch parts of Code on and off for testing. To do so you can comment and uncomment the Lines using // or /**/ Comments.

With longer code parts this can become a real pain. But using Switch Comments you can easily do it by changing just one Character.

Switch Comments are a Combination of Single and Multi line Comments. They start with a: //* and end again with // */. Code that is wrapped that way is fully functional. By simply removing one of the / from the starting Comment the whole Block will be deactivated.

Here's the Example:

Active Comment:


demo = {
    /*
    someTest.Javascript();
    toDemonstrate = 'how Easy';
    // */

    it.is('to make Code appear');
    and = ['disappear','again'];
    this.isVeryUseful('indeed');
};
 
Inactive Comment:

demo = {
    //*
    someTest.Javascript();
    toDemonstrate = 'how Easy';
    // */
    it.is('to make Code appear');
    and = ['disappear','again'];
    this.isVeryUseful('indeed');
};
 

Sadly CSS fails because of the missing Support for // Comments. But Javascript, PHP and many more work nicely with this helpful little thingy.

Update:
My Collegue Steve Webster came up with the logic alternative for CSS:

Comment active:


.test{
    border:1px solid red;
    /*/
    background-color:blue;
    /**/

    margin:1em;
}
 
Comment inactive:

.test{
    border:1px solid red;
    /**/
    background-color:blue;
    /**/
    margin:1em;
}