Info ODIN 3.60
auf dieser Seite:
Ihre Fragen und Anregungen:
ODIN 3.60
ORCUS® ODIN 3.60 ist ein AddIn für das Developer-Studio 6.0 von Microsoft. ODIN fügt auf Knopfdruck kontextbezogene Quelltext- und Kommentarblöcke in Ihren Quelltext ein.
Wieso Sie ODIN einsetzen sollten
Zeit und Qualität zu verschenken?
ORCUS® spart durch den Einsatz von ODIN zwischen 5 und 8 Prozent der gesamten Projektzeit ein - und das bei solider Dokumentation der Schnittstellen.
Ein klarer Wettbewerbsvorteil!
ODIN - die Fleißarbeit macht bei uns der Computer...
Ein Stück Realität - oder ohne ODIN 'dokumentieren'
Das manuelle Beschreiben von Schnittstellen und deren Parametern auf Methodenebene ist i.d.R. eine 'ungeliebte' und fehlerträchtige Handarbeit.
Eine Dokumentation konsistent zur Implementierung zu halten ist ohne ODIN ein sehr zeitintensiver Prozess und verursacht neben steigenden Projektkosten auch noch Engpässe bei der eigentlichen Entwicklung.
Leider laufen Dokumentation und Implementierung mit zunehmenden Projektfortschritt immer wieder oder auch endgültig auseinander. Eine Dokumentation die aber nicht mehr zur Implementierung passt, sorgt zunehmend für Probleme bei der Zusammenarbeit von Entwicklern, wird somit selbst zur Fehlerquelle und auf Dauer nicht mehr als Referenz tragbar.
Im schlimmsten Fall existiert faktisch keine verlässliche Dokumentation mehr und jeder Entwickler beginnt dann immer wieder von neuem den gleichen Quelltext mehr oder weniger richtig zu analysieren. Dass bestehende Funktionalität ignoriert und mehrfach implementiert wird ist dann nur noch eine Frage der Zeit.
... das ist eindeutig ein leider zu oft erlebtes Szenario. Und darauf gibt es von uns eigentlich nur eine Antwort: Verwenden Sie ORCUS® ODIN !
'Schenken' Sie sich einfach die Dokumentation (1)!
Falls Sie - genauso wie ORCUS® - die Verpflichtung zu einen ordentlichem Softwareprozess haben, dann können und dürfen Sie leider die Dokumentation nicht unter den Tisch fallen lassen. :-(
Auch für Ihre Kunden steht neben dem Preis die Qualität Ihrer Produkte an erster Stelle. Wartbarkeit, Debugging und eine erfolgreiche Abnahme sind letztlich auch eine Sache der Dokumentation.
Das bedeutet allerdings nicht, dass Sie unnötig viel Zeit mit der Dokumentation zubringen müssen!
ODIN ermöglicht Ihren Mitarbeitern die projektweit standardisierte Dokumentation Ihrer Quelltexte und entlastet Sie dabei gleichzeitig vom aufwendigen Abschreiben oder manuellem Kopieren und Ausfüllen. Sie müssen selbst nur noch das absolute Minimum an Aufwand investieren!
'Schenken' Sie sich einfach die Dokumentation (2)!
Bei ORCUS® wird immer versucht aus einer guten Lösung eine bessere zu machen! Und ODIN ist da keine Ausnahme.
Stellen Sie doch einmal Ihr Vorgehen bei der Schnittstellendokumentation auf den Kopf:
Pflegen Sie Ihre Dokumentation nicht parallel zum Projekt, sondern Generieren Sie diese einfach aus den Quelltexten!
Das Vorgehensmodell bei ORCUS® sieht z.B. im Abschluss des Designs das Implementieren sämtlicher Schnittstellen als Stubs vor. Die Dokumentation der Schnittstellen erfolgt bei uns obligatorisch vor dem Start der eigentlichen Implementierung.
Nach einer ersten Generierung verfügt damit jeder im Projekt nicht nur über eine Schnittstellendokumentation aller relevanten Anwendungsteile, sondern es kann bereits eine Implementierung gegen die real existierenden Interfaces erfolgen.
Als zusätzlichen positiven Effekt verfügen Sie abhängig von Ihrer Entwicklungsumgebung ( z.B. MS Developer-Studio 6.0) über eine 'IntelliSense'-Unterstützung bei der Implementierung.
Unsere Default-Templates legen Dokumentationsblöcke als XML-Fragmente an.
Dies eröffnet uns und Ihnen eine Vielzahl von Auswertungs- und Verarbeitungsmöglichkeiten.
Mit minimalen Projektanpassungen und unserer XSLT-Aufbereitung erhalten Sie zusätzlich zur Dokumentation im Source eine vollständige Dokumentation in Form von generierten RTF- (z.B. für ihren Review-Verteiler) und HTML-Dokumenten (für ihre Intranet-Online-Dokumentation). Und das einfach als integraler Bestandteil ihres Bauprozesses.
Mit ODIN vermeiden Sie schlicht sämtliche Konsistenzprobleme und 'schenken' sich zusätzlich das redundante Erstellen der Schnittstellendokumentation von Hand!
Für die zusätzliche Integration unserer XSLT-Aufbereitung in Ihren Entwicklungsprozess erstellen wir Ihnen gerne ein verbindliches Angebot - s.u. 'Leistungen'.
Technische Informationen
Template + Tags = Flexibilität
Die Stärke von ODIN beruht auf seinen Kommentar-Templates und einem Satz von Tags die automatisch mit Informationen aus dem Environment und dem aktuellen Bearbeitungskontext gefüllt werden.
So können automatisch Benutzerinformationen aber auch die Argumente von Funktionsaufrufen an den von Ihnen im Template vordefinierten Stellen eingesetzt werden.
Eine kleine Übersicht der unterschiedlichen Template-Anwendungen finden Sie in den Unterseiten.
Standard-Templates und individuelles Anpassen
Nach der Installation wird von ODIN bei der ersten Nutzung automatisch ein Satz von Default-Templates hinterlegt.
Diese können individuell für jeden Nutzer getrennt innerhalb des Developer-Studios angepasst werden.
Für ein globales Deployment 'Ihrer' Default-Templates müssen Sie lediglich einmal Ihren lokalen Registry-Zweig: 'HKEY_CURRENT_USER\Software\Orcus\ ODIN ' als RGS-File abspeichern und innerhalb ihrer Organisation verteilen - einfacher geht's nicht.
Verfügbare Tags
Die verfügbaren Tags lassen sich in drei Gruppen einteilen: Environment, Kontext und Special.
Environment-Tags
Environment-Tags sind unabhängig von der aktuellen Selektion im Quelltext und werden von den Default-Templates zum Bestücken von Modulheadern und Funktions-Dokumentationsheadern eingesetzt.
  • @MOD_NAME@
  • @TODAY@
  • @AUTHOR@
Die Environment-Tags liefern den vollständige Pfad des aktiven Source-Files, das aktuelle Datum und die Uhrzeit (im lokalisierten Datumsformat) und den Benutzernamen entsprechend der Windows-Umgebung.
Kontext-Tags
Kontext-Tags sind abhängig von der aktuellen Selektion im Quelltext und werden von den Default-Templates zum Bestücken von Funktions-Dokumentationsheadern und Bodies von Methoden eingesetzt. Hinweis: Das Default-Template für Methoden-Bodies dient als Beispiel für den produktiven Einsatz unseres Default-Exception-Handlings für OCF-Komponenten in Kombination mit OcfLogger.
  • @FUNC_IDENT@
  • @PARA_LIST@
  • @FUNC_SPEC@
  • @SELECTION@
Die Kontext-Tags liefern bei Selektion einer Methoden-Definition oder Deklaration den Funktionsbezeichner, die Parameterliste unterteilt nach Datentyp, Bezeichner und optionale Initialisierer, sowie den Return-Type inklusive Funktionsspezifizierer.
Das Selection-Tag fügt eine Kopie der aktuellen Textselektion ein und wird im Default-Template zum Ergänzen von Methoden-Bodies eingesetzt.
Special-Tags
Special-Tags sind unabhängig von der aktuellen Selektion im Quelltext und werden von den Default-Templates zum Bestücken von Modulheadern und Bodies von Methoden eingesetzt.
Die Special-Tags helfen Ihnen beim Ausgeben von Revisionskommentaren für MS SourceSafe und beim Positionieren von Ausgaben.
  • @REV_LOG@
  • @LD@
//HOME / Bestellung ODIN