BlueM.Opt Code

From BlueM
Revision as of 07:05, 8 February 2008 by Froehlich (talk | contribs) (→‎Code Formatierung: XML-Kommentare)
Jump to navigation Jump to search
Ablaufdiagramm (EVO-BlauesModell)

Projektstruktur

Der Code besteht aus den folgenden Projekten, welche in einer Projektmappe zusammengeführt werden:

  • EVO: Zentrale Verwaltungseinheit.
    • EVO_Einstellungen.vb: Steuerelement für das Setzen der Optimierungseinstellungen
    • EVO_Opt_Verlauf: Steuerelement, dass den Verlauf der Optimierung anzeigt
    • EVOMOD.vb:
    • Form1.vb: zentrales Formular
    • Diagramm: Unterordner für Diagrammfunktionalität
      • DiagrammForm.vb: Steuerelement, das ein Diagramm und andere Diagramm-Steuerelemente beinhaltet.
      • Diagramm.vb: Klasse, die alle TeeChart-Funktionalitäten zur Verfügung stellt.
      • Scatterplot.vb: Anzeige einer Scatterplot-Matrix
    • Apps: Unterordner für Anwendungen
      • Sim.vb: Basisklasse für Simulationsanwendungen
      • BlueM:
      • S_CAN: Anwendung S:CAN (Sonde Graz)
      • SMUSI: Anbindung an SMUSI
        • Smusi.vb
      • SWMM: Anbindung an SWMM
        • SWMM.vb
        • Swmm_Iface.vb
        • SWMM5.dll: SWMM Rechenkern
      • Testprobleme: Testprobleme (Sinusfunktion, Deb, etc.)
        • Testprobleme.vb
      • SensiPlot.vb: Sensitivitätsanalyse
      • TSP.vb: Traveling Salesman Problem
  • EVO.Kern: Der Optimierungsalgorithmus selbst.
  • Wave: Zeitreihendarstellung (siehe Wave)

Code Formatierung

Es sollte die im VS integrierte Code-Dokumentationsfunktion genutzt werden ("XML-Kommentare"). Anleitung dazu bietet folgender Screencast.

Formatierung von Überschriften: <vbnet>

  1. Region "Überschrift1"

'Überschrift 1 (z.B. Unterteilung zwischen Eigenschaften und Methoden '####################################################################

  'Überschrift 2 (z.B. Größere Gruppen von Funktionen/Subs)
  'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      <summary>
      XML-Kommentare für Methoden, Eigenschaften, Felder etc.
      </summary>
     Sub Beispiel()
        'Untertitel 1
        'xxxxxxxxxxxx
           'Untertitel 2
           '============
              'Untertitel 3
              '------------
              'Normale Kommentare
     End Sub
  1. End Region 'Überschrift1

</vbnet>

Tokens

Folgende Tokens werden im Code benutzt:

Token Bedeutung
ACHTUNG Wichtiger Kommentar
BUG Betrifft einen Bug in Bugzilla
TODO Noch zu tun
HACK Temporäre Lösung
UNDONE ???
CHECK ???
UPGRADE Kleine mögliche Erweiterungen innerhalb von Funktionen
UPGRADE_NOTE Beim Update von VB6 auf VB generierte Kommentare
UPGRADE_WARNING Beim Update von VB6 auf VB generierte Kommentare
UPGRADE_ISSUE Beim Update von VB6 auf VB generierte Kommentare