Ich habe mehrere Camel-Kontexte in meinem Projekt und möchte die Routen möglichst reverse-engineering-mäßig dokumentieren, da wir die Dokumentation aktuell im Kontext halten wollen. Was wäre der beste Ansatz?Dokumentieren von Kamelrouten
Antwort
Wir neigen dazu, die Routen im Voraus zu entwerfen und sie mit der Ikonographie aus der EIP book zu modellieren. Das gibt uns eine Anleitung, um dann unsere Routen zu testen. Ändern sich Ihre Routen wirklich so oft, dass Reverse Engineering erforderlich ist? Wir suchen langsam nach einem dynamischen UI für unsere Routen - aber das wird nicht vor 2011 sein :)
Sie können nur Dokumentation in der tatsächlichen DSL hinzufügen und dann einige Werkzeuge oder was auch immer, die diese Route extrahiert und Dokumentation.
Im Frühjahr XML DSL sollten Sie Elemente zu den EIPs in der Route hinzufügen können. Sie können auch allgemeine XML-Kommentare hinzufügen.
Auch wie oben erwähnt ist einige GUI-Tooling auch, was einige Leute verwenden möchten. Dann ist oft das visuelle Diagramm der Routen mit den EIP-Icons die Dokumentation.
FuseSource erstellt derzeit ein GUI-Tool namens FuseSource Rider. Es wird in diesem Monat in der öffentlichen Betaversion sein.
Bei Apache Camel gibt es einige Maven Werkzeuge für http://camel.apache.org/visualisation.html
- 1. Dokumentieren von CMake-Skripten
- 2. Zugriff auf Domänenklassen oder Spring Beans von Kamelrouten in Grails
- 3. Software zum Dokumentieren von Code?
- 4. Dokumentieren von Angular2 TypeScript-Code
- 5. Dokumentieren von Salesforce.com Apex-Klassendateien
- 6. Verwenden von CSDL zum Dokumentieren von Entitäten
- 7. Dokumentieren bestehenden Code
- 8. Einen Abhängigkeitsbaum dokumentieren
- 9. Dokumentieren CakePHP Komponenten
- 10. Dokumentieren Jersey Rest api
- 11. Dokumentieren Scala 2.10 Makros
- 12. browserifizieren und dokumentieren bereit?
- 13. Wiki-Software zum Dokumentieren von APIs
- 14. Dokumentieren einer Liste von Datenrahmen mit roxygen2
- 15. Dokumentieren von Funktionen in C++ mit Doxygen
- 16. Dokumentieren von Python-Koroutinen mit Sphinx autodoc
- 17. Dokumentieren von Gleichungen mit deqn und roxygen
- 18. Dokumentieren komplexer ORM-Abfragen
- 19. Wie dokumentieren Sie Funktionsargumente?
- 20. Dokumentieren Rebol Dialekt
- 21. Dokumentieren Getter und Setter
- 22. Wo kann man Kommentare dokumentieren?
- 23. Wie dokumentieren Sie Ihre Datenbankstruktur?
- 24. Eine Message Bus API dokumentieren?
- 25. Wie dokumentieren Sie AngularJS-Richtlinien?
- 26. Bester Weg zum XML-Dokumentieren
- 27. einen komplizierten Mechanismus erklären/dokumentieren
- 28. Verwendung von JSDOC3 zum Dokumentieren von Enum-Konstanten
- 29. JSDoc - Dokumentieren ein gemischtes Array
- 30. Wie dokumentieren Rückrufe mit JSDoc?
Die ursprüngliche Dokumentation gui Diagramme zu erzeugen erfolgt Business Process Modeling Notation (BPMN) und eine Menge Arbeit getan wurde, verwendet wird, die Wege sind nicht mehr im Einklang mit die BPMN. Unser Problem kommt, weil einer der Teammitglieder gegangen ist und keine Zeit hatte, seine Arbeit zu dokumentieren. Die Routen sind nicht vollständig definiert, da es ein sehr großes Projekt ist (EU-Forschungsprojekt) und die Spezifikationen sich ändern, wenn neue Anforderungen identifiziert werden. – Monachus