AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Thema durchsuchen
Ansicht
Themen-Optionen

XML-Kommentare für Units, Variablen

Offene Frage von "RSE"
Ein Thema von RSE · begonnen am 13. Mär 2012
Antwort Antwort
RSE

Registriert seit: 26. Mär 2010
254 Beiträge
 
Delphi XE Enterprise
 
#1

XML-Kommentare für Units, Variablen

  Alt 13. Mär 2012, 17:16
Hallo,

ich bin gerade dabei, mich mit Quelltextdokumentation mittels XML-Kommentaren zu beschäftigen. Es wird überall über die Kommentierung von Methoden geschrieben. Die Kommentierung einer Klasse oder Konstante scheint genauso zu funktionieren (Help Insight reagiert), aber wie sieht es mit der Kommentierung der Unit als Ganzes oder einer Variablen aus? Gibt es dafür andere standardisierte XML-Formate, oder reagiert Help Insight einfach nur nicht darauf und die Formate sind gleich?

Ich möchte folgende Sachen dokumentieren:
  • Intuition und Verwendung des Moduls (Zusammenspiel der public Methoden und Klassen) -> in der entsprechenden Unit, z.B. vor dem interface-Abschnitt
  • Intuition und Verwendung einer Klasse -> direkt vor ihrer Deklaration (Format geklärt)
  • Verwendung von Methoden, Prozeduren und Funktionen -> direkt vor ihrer Deklaration (Format geklärt)
  • Bedeutung und Verwendung von Variablen -> dort, wo die Variablen deklariert sind (var-Abschnitt oder Klassendeklaration)
  • Interne Funktionsweise des Moduls (Zusammenspiel der private Methoden und Hilfsklassen) -> in der entsprechenden Unit, z.B. am Anfang des implementation-Abschnitts
  • Interne Funktionsweise von Methoden, Prozeduren und Funktionen -> in der Implementierung der Methode, Prozedur oder Funktion (Klartext, wird ausschließlich im Code benötigt)
Dabei möchte ich mich natürlich an ggf. bestehende etabliete Formate, wie z.B. die XML-Kommentare über Methodendeklarationen halten. Wenn die Anordnung der Kommentare in euren Augen unsinnig ist, bitte ich um Begründungen bzw. Alternativen, wo diese Kommentare üblicherweise zu finden sind.
"Seit er seinen neuen Computer hat, löst er alle seine Probleme, die er vorher nicht hatte."
  Mit Zitat antworten Zitat
Antwort Antwort


Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 08:35 Uhr.
Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz