Automatyczna dokumentacja - Najlepsza metoda tworzenia szybki parser

głosy
0

Mam duży skrypt, że użytkownicy końcowi muszą zmieniać więc wymaga nieco zbędny komentowania. Używam układ dla moich plików podobny do tego

//********************
//
// FileName
//    This script contains:
//    - Function X - does something
//    - Function Y - does something else
//
//********************

//********************
// Function X
// does something (<< I'd only like to enter this part once)
//********************
// Code here...

//********************
// Function Y
// does something else
//********************
// Code here...

Chcę stworzyć prosty parser, który robi się kopiowania / wklejania podsumowań funkcyjnych do nagłówka pliku. Znam kilku narzędzi, które mogłyby przyczynić się do osiągnięcia tego celu, a nawet jak antlr RegEx, ale jaki byłby najlepszy sposób?

Utwórz 01/12/2009 o 23:35
źródło użytkownik
W innych językach...                            


1 odpowiedzi

głosy
1

Biorąc pod uwagę dwie opcje wspomnieć ANTLR i Regex, chciałbym zaproponować ANTLR. ANTLR będzie bardziej elastyczny w dłuższej perspektywie, i wierzę, powinieneś być w stanie go bardziej efektywnie wykorzystać (Analizuje siedzibą w gramatyk). Regex podejścia będzie ograniczona do regularnych języków, chyba że w jakimś niestandardowym dodać logiki i etażerka.

Jako przykład, podejrzewam masz trudność identyfikacji komentarze znajdujące się wewnątrz bloków vs poza blokami z wyrażenia regularnego. CFG powinien być w stanie dokonać takiego rozróżnienia dobrze. Potem znowu, jeśli masz kontrolę nad źródłem można sporządzić tylko niektóre specyfikacje, jakie rodzaje komentarzach pojawiają się tam, ...

Odpowiedział 02/12/2009 o 04:43
źródło użytkownik

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