Duplizieren Wartung - Code und Dokumentation [geschlossen]

Question

Das ist vielleicht nicht der besten Titel sein - ich würde es begrüßen, wenn jemand mit einem besseren kommen würde mein Problem nach der Lektüre. Auch möchte ich vorne sagen, dass ich im Internet weitgehend Autodidakt bin, so kann es viele Werkzeuge, die ich bin mir nicht bewusst.

Ich bin die Pflege von Software, das Flow-basierte Programmierung (FBP) Konzept in # Java und C implementiert. Für jeden dieser habe ich Code auf:

• Sie meine Website
• Source Datei-Release-System (zip-Dateien oder JAR-Dateien)
• Source SVN

Darüber hinaus habe ich Version Referenzen und (manchmal teilweise) Beschreibungen auf:

• meiner Webseite (HTML)
• mein Wiki
• Javadoc

Es gibt auch ein Zeichenwerkzeug, auch auf meiner Website und Source, die über die neueste Version der Java-Version des FBP-Code kennen muss.

Alles ist vernetzt ziemlich gründlich, aber manchmal vermisse ich eine Referenz! Vor ein paar Tagen, wurde mir klar, dass ich für mein Projekt in einer langen Zeit nicht mehr aktualisiert Source Nachrichten hatte, so musste ich das :-) Hektik und tun

Ich weiß, dass einige dieser Fahrzeuge wahrscheinlich überflüssig sind, aber im Allgemeinen, ich weiß nicht, wer was gerade ist.

Also meine Frage ist, ob es einen Weg gibt, all diesen Aufwand zu reduzieren, zum Beispiel eine HTML „imbed“ -Funktion wäre schön, so kann ich die aktuelle Versionsnummer in einem Ort mindestens speichern. Ich kann wahrscheinlich die Java-Querverweise vereinfachen, aber zwischen Sprache wäre noch schöner, aber unwahrscheinlich, schätze ich.

Irgendwelche Ideen wäre willkommen.

Answer 1

Es scheint mir, dass Sie aktualisieren möchten, und pflegen Sie Ihre Dokumentation als Teil Ihres Build / deploy Prozess z.

1. bauen
2. Unit-Test usw.
3. kompilieren Dokumentation
4. deploy baut
5. bereitstellen zusammengestellt Dokumentation

sonst bist du immer geht Ihr Schwanz zu jagen. Offensichtlich ist die Dokumentation Einsatz verschiedene Lösungen auf benötigen, wohin es geht (zum Beispiel auf Ihre Website kopiert, FTPed an anderer Stelle usw.)

Ich bin nicht sicher, für all dies ein Allheilmittel gibt. Ich behaupte, Versionsnummern in Properties-Dateien / config-Dateien und tun entsprechende Such / ersetzt. Code-Dokumentation, wo immer möglich, geht in dem Code selbst, und dann ist das in meinem Build (Schritt 3 oben) vorverarbeitet.

Haben Sie gesehen / gebrauchte doxygen ? Das wird Ihre mehrsprachigen Anforderungen verarbeitet und ist gut für Gebäude errichtet / Dokumentation beibehalten wird.

Answer 2

Es klingt wie Sie Ihren Build / Publishing-Prozess automatisieren müssen. Ich lese diesen Artikel auf O'Reilly eine Weile zurück - es scheint, dass Sie beide eher ähnlichen Situationen haben? Seine Lösung macht intensiven Gebrauch von Python, aber zumindest, es könnten Sie ein paar Ideen.