Program for å dokumentere en C struct?

stemmer
2

Hvis du har et binært filformat (eller pakke format) som er beskrevet som en C struktur, er det noen programmer som vil analysere struktur og slå den inn i ryddig dokumentasjon på protokollen?

Struct ville selvsagt inneholde andre matriser, strukturer, etc. etter behov for å beskrive den format. Dokumentasjonen vil trolig må inkludere ting som pakking, endianness, etc.

Publisert på 15/12/2008 klokken 21:37
kilden bruker
På andre språk...                            


5 svar

stemmer
5

Kanskje du bør tenke på dette på en annen måte.

"Kan jeg lage en dokumentasjon format for min pakke som jeg kan generere en C struct?"

Tenk for eksempel ved å bruke XML til å definere pakkestrukturen og legge til elementer for merknader og så videre. Det wil være ganske enkelt å skrive et enkelt program som forvandlet den til en faktisk C struktur

Svarte 15/12/2008 kl. 21:46
kilden bruker

stemmer
2

Doxygen er en vanlig brukt doc umentation gen erator. Men hvis du ønsker å få nyttig dokumentasjon, vil du sannsynligvis nødt til å markere opp struktur definisjoner med doc kommentarer.

Svarte 15/12/2008 kl. 21:45
kilden bruker

stemmer
1

Hvis du vet perl kan du prøve å spille med Jeeves:

https://www.rodhughes.com/perl/advprog/examples/Jeeves/

(Denne kilden er der, jeg antar det er greit å bruke;.))

Jeg prøver å finne ut noe som ligner på det du trenger: en parser for strukturerte binære data. Jeg ønsker å Jeeves til utgang parsing klasser i C ++ fra en meta-format. Standard parser for Jeeves åpner for å legge til flere koder til hvert medlem av en klassedefinisjon. Dette vil la deg automatisk inkludere informasjon om endianness, justering, etc. i kommentarer i klassene (og, selvfølgelig, implementere dem i koden).

Svarte 15/12/2008 kl. 22:29
kilden bruker

stemmer
0

Selvfølgelig, hvis noe slikt eksisterte, ville det bli brukt til å skrive protokoll dissectors for Wireshark - det faktum at hver dissector er implementert i C-kode innebærer at det er vanskelig å uttrykke binære formater på en generisk måte

Svarte 15/12/2008 kl. 22:28
kilden bruker

stemmer
0

som JaredPar sier, en alternativ frasering av dette spørsmålet er:

"Hva er en god metode for å beskrive binære strukturer?

for eksempel noe sånt ABNF men i stand til å gjøre litt pakking, endianness, etc.

helst ville det være eksisterende verktøy for å generere ikke bare dokumentasjon, men C-hoder, pakke ut eller struct mønstre og validering verktøy basert på beskrivelsen"

Svarte 15/12/2008 kl. 22:07
kilden bruker

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more