Generator dokumentacji projektu w Delphi

Generator dokumentacji projektu w Delphi
maniutek20
  • Rejestracja:prawie 14 lat
  • Ostatnio:7 dni
  • Postów:138
0

Szukam czegoś co usprawniłoby proces tworzenia dokumentacji w Delphi. Najbardziej interesuje mnie jakiś generator który na podstawie pliku pas wyplułby kod html, najlepiej podzielony na klasy, funkcje, parametry, zmienne itd. Trafiłem już na Doxygen, delphitodoc, robodoc i inne rozwiązania które podsunął wujek google, ale dziwnym trafem większość tych projektów nie jest rozwijana od średnio 8 lat. Doxygen nie współpracuje z Delphi na zadowalającym poziomie, poza tym to wielki kombajn, nie wiem czy wykorzystam jego możliwości choćby w 10%. Potrzebne mi coś lekkiego a jednocześnie w miarę intuicyjnego żeby nie trzeba było poświęcać na naukę składni 2 tygodni. Korzystacie z czegoś wartego polecenia (i o rozsądnym budżecie)?


quidquid Latine dictum sit, altum videtur
0
olesio
  • Rejestracja:prawie 17 lat
  • Ostatnio:około 3 lata
  • Lokalizacja:Szczecin
  • Postów:4191
0

O kurcze, faktycznie w dokumentacji od Synapse widnieje na dole Generated by PasDoc.... Byłem przekonany, że to pytający również sprawdził. I jest to dla niego rozwiązania niewystarczające. Przecież to oczywiste, że dokumentacja pakietu Synapse jest według mnie i pewnie nie tylko mnie, jedną z fajniej przygotowanych, wygodnych w nawigacji i przejrzystych. Tak że dlaczego by nie używać PasDoca.


Pozdrawiam.
edytowany 2x, ostatnio: flowCRANE
flowCRANE
Mały retusz ;)
maniutek20
  • Rejestracja:prawie 14 lat
  • Ostatnio:7 dni
  • Postów:138
0

Właściwie to od Pasdoc zacząłem, ale szanowne kierownictwo patrzyło krzywo, że niby nieprzejrzyste. Chociaż pewnie ostatecznie na tym stanie. Robiłem dzisiaj drugie podejście do Robodoc, bo ma takie coś co doda mi do kodu komentarze (robohdrs), ale niestety działa ten ficzer tylko pod linuxem, a to kolejna górka do przeskoczenia. Generalnie to trochę ciężki temat jeśli chodzi o Delphi, liczyłem że będzie szybko miło i przyjemnie, najlepiej z poziomu IDE. Ściągnąłem nawet trial Documentation Insight z DevJet, ale pod XE7 nie działa jakoś powalająco. Może dorzucę trochę założeń: stworzenie dokumentacji do istniejącego kodu (ok 300k linii kodu), na podstawie komentarzy umieszczonych w pliku pas. Szablon komentarzy powinien być tworzony automatycznie (nad,pod, obok deklaracji funkcji, procedur, zmiennych), a zadaniem osób wykonujących dokumentację miałoby być wstawienie opisów, ewentualnie dodanie znaczników (np. dla fragmentów kodu). Tyle założeń, natomiast przyznam szczerze że blado to widzę. Na razie mam takie wrażenie że Doxygen ma o milion opcji za dużo a PasDoc o 10 za mało


quidquid Latine dictum sit, altum videtur
WL
  • Rejestracja:około 21 lat
  • Ostatnio:około 2 miesiące
  • Postów:1082
0

Co Ci nie pasuje w Documentation Insight? Ma wszystko czego potrzebujesz i znacznie więcej też ;-)

maniutek20
  • Rejestracja:prawie 14 lat
  • Ostatnio:7 dni
  • Postów:138
0

Coś mi w tym DI nie działało poprawnie, ale pobrałem starszą wersję i teraz prawie działa (na XE7 Pro). Właściwie to mi się podoba, najbardziej to chyba że wszystko mam na jednym ekranie. Dałem do zaopiniowania księgowym dwie wersje płatną DI i darmowego PasDoc'a, ciekawe co wybiorą:)


quidquid Latine dictum sit, altum videtur
Opi
  • Rejestracja:ponad 20 lat
  • Ostatnio:2 dni
  • Postów:1029
0

Nie wiem, czy w tym kierunku, ale może.... Pascal Analyzer lub Pascal Browser (raczej ten ostatni: http://www.peganza.com/products_pab.html)

edytowany 1x, ostatnio: Opi
Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)