AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Sprachen und Entwicklungsumgebungen Die Delphi-IDE Tool zum Überprüfen von Dokumentation von Methoden
Thema durchsuchen
Ansicht
Themen-Optionen

Tool zum Überprüfen von Dokumentation von Methoden

Ein Thema von TheFrog · begonnen am 12. Feb 2015 · letzter Beitrag vom 16. Feb 2015
Antwort Antwort
Benutzerbild von Stevie
Stevie

Registriert seit: 12. Aug 2003
Ort: Soest
4.045 Beiträge
 
Delphi 10.1 Berlin Enterprise
 
#1

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 13. Feb 2015, 09:24
Documentation Insight kanns nicht, das hab ich vorhin ausprobiert.
Ich verstehe nicht- Das ist doch im RAD Studio alles schon eingebaut? Und grade das baut doch auf Documentation Insight auf.
  • Warnungen wenn ich einen Parameter nicht dokumentiert habe
  • Wenn ich einen Parameter dokumentiere den es nicht (mehr) gibt
  • Und vieles mehr

Siehe Bilder.


Einen "Babysitter" mit "Hey, du hast an der Implementation etwas verändert. Hast du denn auch schön die Doku angepasst?" kenne ich allerdings auch nicht.
Ich hab auf Validate Documentation geklickt und da hats mir nix ausgespuckt.
Wenn allerdings der Compiler solche Optionen hat, dann ist ja alles geritzt.

Edit: Gerade mal ausprobiert. Dazu muss man bei den Compiler Optionen "Generate XML documentation" anhaken. Leider bekommt man bei den Messages nicht die richtige Zeilennummer, was das ganze nahezu unbrauchbar macht.
Stefan
“Simplicity, carried to the extreme, becomes elegance.” Jon Franklin

Delphi Sorcery - DSharp - Spring4D - TestInsight

Geändert von Stevie (13. Feb 2015 um 09:39 Uhr)
  Mit Zitat antworten Zitat
Der schöne Günther

Registriert seit: 6. Mär 2013
6.199 Beiträge
 
Delphi 10 Seattle Enterprise
 
#2

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 13. Feb 2015, 09:45
Leider bekommt man bei den Messages nicht die richtige Zeilennummer, was das ganze nahezu unbrauchbar macht.
Es geht- Man hat immerhin den Methodennamen. Besser als nichts.
  Mit Zitat antworten Zitat
Benutzerbild von Stevie
Stevie

Registriert seit: 12. Aug 2003
Ort: Soest
4.045 Beiträge
 
Delphi 10.1 Berlin Enterprise
 
#3

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 13. Feb 2015, 09:51
Deshalb schrieb ich auch "nahezu" unbrauchbar
Stefan
“Simplicity, carried to the extreme, becomes elegance.” Jon Franklin

Delphi Sorcery - DSharp - Spring4D - TestInsight
  Mit Zitat antworten Zitat
Benutzerbild von Chemiker
Chemiker

Registriert seit: 14. Aug 2005
1.859 Beiträge
 
Delphi 11 Alexandria
 
#4

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 15. Feb 2015, 15:11
Hallo,

„Documentation Insight“ scheint es in der Prof.-Version von XE3 aber nicht zu geben. Von daher ist es für den Beitragsersteller irrelevant.

Bis bald
Chemiker
wer gesund ist hat 1000 wünsche wer krank ist nur einen.
  Mit Zitat antworten Zitat
Benutzerbild von Uwe Raabe
Uwe Raabe

Registriert seit: 20. Jan 2006
Ort: Lübbecke
11.643 Beiträge
 
Delphi 12 Athens
 
#5

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 15. Feb 2015, 15:21
„Documentation Insight“ scheint es in der Prof.-Version von XE3 aber nicht zu geben. Von daher ist es für den Beitragsersteller irrelevant.
In dem Fall kann er es aber immer noch käuflich erwerben.
Uwe Raabe
Certified Delphi Master Developer
Embarcadero MVP
Blog: The Art of Delphi Programming
  Mit Zitat antworten Zitat
Der schöne Günther

Registriert seit: 6. Mär 2013
6.199 Beiträge
 
Delphi 10 Seattle Enterprise
 
#6

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 15. Feb 2015, 15:43
„Documentation Insight“ scheint es in der Prof.-Version von XE3 aber nicht zu geben.
Klar, von XE2-XE5 war es dabei.
  Mit Zitat antworten Zitat
Benutzerbild von Chemiker
Chemiker

Registriert seit: 14. Aug 2005
1.859 Beiträge
 
Delphi 11 Alexandria
 
#7

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 15. Feb 2015, 16:14
Hallo,

Zitat:
Klar, von XE2-XE5 war es dabei.
Stimmt, aber in XE6 und XE7 ist es nicht mehr dabei, warum auch immer. Und es ist dann blöd, wenn man damit angefangen hat und es dann bei der nächsten Version wieder als Tool nicht zur Verfügung steht.


Bis bald
Chemiker
wer gesund ist hat 1000 wünsche wer krank ist nur einen.
  Mit Zitat antworten Zitat
Benutzerbild von Uwe Raabe
Uwe Raabe

Registriert seit: 20. Jan 2006
Ort: Lübbecke
11.643 Beiträge
 
Delphi 12 Athens
 
#8

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 15. Feb 2015, 16:36
Und es ist dann blöd, wenn man damit angefangen hat und es dann bei der nächsten Version wieder als Tool nicht zur Verfügung steht.
Aber es steht doch noch zur Verfügung - halt nicht mehr gratis. Das ist doch ein durchaus gängiges und legitimes Verfahren, ein neues Produkt erstmal durch Gratisabgabe schmackhaft machen und danach kostenpflichtig anzubieten. Dann kann ja jeder selbst entscheiden ob es einem den Preis wert ist. Selbst QuickReport (war als Standardversion gratis in D3 - D7 dabei) kann man heute noch für aktuelle Delphi-Versionen kaufen.
Uwe Raabe
Certified Delphi Master Developer
Embarcadero MVP
Blog: The Art of Delphi Programming
  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 14:56 Uhr.
Powered by vBulletin® Copyright ©2000 - 2025, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024-2025 by Thomas Breitkreuz