Kommentar (programmering)

Kommentarer (fra latin for "note") er et middel for strukturering av programkildekode , der produksjonen er automatisert programtekst og programmeringsassosierte hjelpefiler delvis. Informasjon fra kildeteksten kalt metadata eller metainformasjon, kommentarer og kommentarer eller attributter brukes som informasjonsgrunnlag for automatisk generering av tilleggsfilene . Informasjonen blir ignorert når kompilatoren oversetter den .

Programmeringsspråk som muliggjør denne typen integrering av metainformasjon inkluderer Java , C # og VB.NET . Ved hjelp av tilleggsverktøy kan metainformasjon også legges inn i språk hvis syntaksen ikke eksplisitt støtter dette. Metadataene blir da vanligvis skjult for kompilatoren i kommentarer og evaluert med tilleggsverktøyene.

Attributter i C # og VB.NET

I C # og VB.NET tilordnes metadata i form av attributter. Attributter kan spesifiseres for samlinger, klasser, strukturer, metoder, parametere, felt og oppregninger. Hver enkelt attributt er spesifisert i firkantede (C #) eller vinkelparenteser (VB.NET) foran det respektive språkelementet. Attributtparametere brukes på samme måte som parametere for metoder og egenskaper.

Følgende eksempel viser hvordan attributtene brukes Obsoletetil å markere utdatert kode og DllImportå inkludere ikke-administrerte (native) samlinger via COM interop.

// Eine Methode (hier Foo) als veraltet markieren.
// Der Parameter vom Typ System.String wird u. a. von IDEs als Hinweistext verwendet.
[Obsolete("Verwenden sie die Methode Bar.")]
public void Foo(string stringParam)
{
    //...
}

// Import der Win32 MessageBox.
// Der Konstruktor von DllImport nimmt hier ein Argument entgegen ("user32.dll"),
// die Klasse DllImport verfügt über eine Eigenschaft CharSet, der ein Wert zugewiesen wird.
[DllImport("user32.dll", CharSet = CharSet.Unicode)]
public static extern int MessageBox(IntPtr hWnd, String text, String caption, uint type);

I tillegg til standardattributtene som tilbys av .NET framework, er det også mulig å definere dine egne attributter. For å gjøre dette må du lage din egen klasse som System.Attributekommer fra.

Følgende eksempel viser definisjonen av et enkelt attributt Autor:

// Definieren des Attributs "Autor"
[System.AttributeUsage(System.AttributeTargets.Class |
                       System.AttributeTargets.Struct)
]
public class Autor : System.Attribute
{
    private string _vorname;
    private string _nachname;

    public Autor(string vorname, string nachname)
    {
        _vorname = vorname;
        _nachname = nachname;
    }
}

// Verwenden des Attributs "Autor"
[Autor("Max", "Mustermann")]
class BeispielKlasse
{
    //...
}

Kommentarer i Java

Med Javadoc og kommentarene gir Java-programmeringsspråket to mekanismer for integrering av metadata. Disse brukes spesielt i Jakarta EE- miljøet for automatisk å generere forskjellige filer. Disse inkluderer for eksempel SQL-filer, distribusjonsbeskrivere og grensesnittene som er koblet til Enterprise Java Beans (eksternt grensesnitt, hjemmegrensesnitt ...).

Javadoc

Javadoc er et verktøy for å evaluere kommentarer i kildekoden som ble introdusert med Java 1.2. For dette formålet blir kommentarer som skal evalueres introdusert med tegnstrengen /**. Spesielle koder kan deretter brukes i disse kommentarene, og hver tildeles en tegnstreng som verdi.

Evalueringen utføres ved hjelp av Javadoc-verktøyet med samme navn, som opprinnelig ble designet for automatisert kildekodedokumentasjon. En annen mulighet er XDoclet , som spesielt brukes i Jakarta EE- miljøet . Følgende eksempel viser hvordan du spesifiserer programvareversjonen ved hjelp av Javadoc:

 /**
  * @version 1.5
  */
public class A {}

Kommentarer (fra Java 5)

Med språkversjonen Java 5 ble merknader opprettet som et eget språkelement. Kommentarer identifiseres i kildeteksten med et @ -tegn etterfulgt av navnet på kommentaren. Det er også mulig å overføre parametere til merknader. Du kan også legge til dine egne kommentarer til de gitte kommentarene.

Kommentarer kan evalueres ved hjelp av Annotation Processing Toolkit (APT) direkte i kildeteksten eller ved hjelp av refleksjon i løpet av et program. Dette skaper blant annet ytterligere mulige bruksområder sammenlignet med Javadoc. For eksempel evaluerer kompilatoren noen merknader. Følgende eksempel viser hvordan du kan undertrykke en kompilatorvarsel ved å bruke riktig kommentar:

 public class A {
   @SuppressWarnings("unchecked")
   public void meineMethode() {}
}

Fra og med Java 6 er APT-verktøyet allerede integrert i Java-kompilatoren. Fra og med Java 8 leveres ikke APT-verktøyet lenger separat.

Individuelle bevis

1. ↑ Microsoft Developer Network: Attributter (C # og Visual Basic). Hentet 29. november 2011 . 
2. ↑ MSDN: Opprette egendefinerte attributter (C # og Visual Basic). Hentet 29. november 2011 .