Utility di documentazione per OpenEdge ABL

Question

Utility di documentazione per OpenEdge ABL

#1 da (3 voti)
#2 da (1 voti)
#3 da (0 voti)
#4 da (-1 voti)

2

Ho un grande sistema in OpenEdge ABL che potrebbe usare un po 'di documentazione-amore. Attualmente un membro del team sta lavorando a un'utilità che può trovare metodi e funzioni e creare alcune pagine html "Javadoc-esque". È piuttosto ruvido intorno ai bordi. Va bene, è come le lame seghettate ai bordi.

Sto cercando di trovare qualcosa come Javadoc o Doxygen che sia in grado di analizzare OpenEdge ABL per generare una sorta di documentazione API. So che il mercato di OpenEdge non è delle migliori, ma ci sono molte cose che passano di bocca in bocca. È difficile da cercare perché si chiamava "Progress", che elimina le query di ricerca con informazioni non pertinenti.

Sono aperto anche a un sistema che consente di definire le espressioni regolari da cercare per definire la propria sintassi. Quindi analizza e ti dà un output basato su quello.

documentation-generation

posta corsiKa 15.06.2011 - 22:35

fonte

4 risposte

Leggi altre domande sui tag documentation-generation

Fai / come funzionano i vari framework flessibili con Flash Builder Ha senso per le informazioni automatiche raccolte dal sistema legacy

score 3 · Answer 1

Ho scritto un convertitore xref- > TT anni fa, che separa i file sorgente e restituisce tutti i tipi di elementi, incluse le API e i relativi elenchi di parametri. Puoi trovare il file del codice sorgente qui: link

Un avvertimento è che ho smesso di lavorare su questo ~ 2008, quindi il codice sarà un po 'obsoleto. Se la tua base di codice non usa troppo OOABL, penso che dovresti essere bravo.

score 1 · Answer 2

Se usi OpenEdge 11.5 o successivo, puoi usare ABLDoc .

Dato che OpenEdge è ampiamente retrocompatibile, puoi anche usare questo strumento se hai un'installazione 11.5, anche se sviluppi principalmente in un'altra versione.

Dalla Knowledgebase di progresso :

Does Progress provide a tool similar to javadoc for OpenEdge ABL?

Progress provides an ABLDoc starting from version 11.5, and runs from Progress Developer Studio (PDS). Also Apache Ant can be used to generate ABL Documentation.

score 0 · Answer 3

Non conosco alcuna utilità che possa farlo.

MA. Se il tuo codice è tutto in procedure strutturate e include strutturate - cioè, scritto in AppBuilder anziché in file di testo diretto - allora dovrebbe essere relativamente banale creare un semplice report in stile Javadoc per l'intero sistema. È solo questione di cercare i tag del preprocessore che l'AppBuilder scrive nel codice.

Nell'evento (relativamente improbabile, purtroppo) che stai usando Openedge sotto * NIX, potresti probabilmente ottenere il massimo con Bash, Awk e grep ...

Guardando il codice che ho qui, alcuni suggerimenti per te nel caso in cui aiuti (se questo è troppo ovvio, le mie scuse):

&ANALYZE-SUSPEND _VERSION-NUMBER <Progress version>
&Scoped-define PROCEDURE-TYPE <Window,etc>
&ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE <procedure name>
&ANALYZE-SUSPEND _UIB-CODE-BLOCK _FUNCTION <function name>

Forse potrei aiutarti di più - fammi sapere.

score -1 · Answer 4

-1

Abbiamo riscontrato lo stesso problema con un codebase legacy non documentato (e di grandi dimensioni). Stiamo pensando di provare RoboDoc, dato che sembra interessare solo i commenti (i commenti in stile c di Progress sono supportati).

risposta data 20.05.2012 - 21:26

fonte