Einzelnen Beitrag anzeigen

Benutzerbild von Harry Stahl
Harry Stahl

Registriert seit: 2. Apr 2004
Ort: Bonn
2.538 Beiträge
 
Delphi 11 Alexandria
 
#137

AW: Pascal Project Manager & Editor

  Alt 5. Mai 2020, 20:07
Ich bin gerade dabei, die schon mal vor einiger Zeit angekündigte Dokumentations-Funktion einzubauen.

Dazu habe ich erst mal eine Möglichkeit geschaffen, die Parameter, die Delphi selber als XML-Dokumentations-Tags anbietet, wenn man Strg+J drückt, mit Hilfe eines kleinen Dialog-Fensters sehr viel einfacher eingeben oder ändern zu können, siehe anliegenden Screenshot.

XML-Parameter gibt es aber auch weitere, daher wollte ich mal hier die Frage stellen, ob man zusätzliche Parameter hier anbieten sollte (vgl: https://docs.microsoft.com/de-de/dot.../codedoc#param) oder reicht es im Prinzip so?

Weiterhin: Ich überlege, ob ich kurze Einträge statt mehrzeilig, einzeilig erfassen soll,

also statt:

/// <summary>
/// Looks for a special Message
/// </summary>

lieber so:

/// <summary>Looks for a special Message</summary>

Gibt es irgendwelche Tools, die damit nicht zurecht kommen oder andere Gründe diese 2. Variante nicht zu wählen? Immerhin nimmt diese nur eine Zeile weg.
Bei 3 unterschiedlichen XML-Tags mit kurzen Einträgen hätte man nur 3 statt 9 Zeilen...

Hinweis: Diese Funktion ist noch nicht in der Version auf meiner HP enthalten...
Miniaturansicht angehängter Grafiken
doc.jpg  

Geändert von Harry Stahl ( 5. Mai 2020 um 20:10 Uhr)
  Mit Zitat antworten Zitat