DoXGen ~ Interpretacja, ewaluacja, taka sytuacja

9
W końcu ogarnąłem tą dokumentację xD

Dla nie w temacie wytłumaczę:
Interpretacja, ewaluacja, streszczanie kodu źródłowego

Poglądowo zademonstruję
Algorytm bierze taki oto kod:
DoXGen ~ Interpretacja, ewaluacja, taka sytuacja
I generuje taką dokumentację:
[templatka do snippetów]

(Mam też templatkę do całego projekttu, oraz do generowania templatek z tekstu do kodu i odwrotnie :v
DoXGen ~ Interpretacja, ewaluacja, taka sytuacja
Jak ktoś jest ciekawy to piszcie na Discordzie:
'sx66'
Poza samą analizą kodu / projektu, będą jeszcze inne funkcje, mianowicie dodatkowe:
- Metadane 
(By ułatwić analizę projektu / pliku przez maszynę jak i człowieka

Tu wrzucam wyniki preliminarnego testu ewaluacyjnego
https://pastebin.com/nhpCrU2N

Jak skończę front i back end oraz assety w stylu templatki, chuje muje to wrzucę na GitHuba zapewne, jak wszystko inne :)

Na dole jeszcze dorzucam poglądowo nadchodzące metadane i takie tam:
DoXGen ~ Interpretacja, ewaluacja, taka sytuacja
Ogólnie to jak masz wykupione API do OpenAI to mogę się podzielić front-endem i assetami.
Ewentualnie jeśli masz jakiś niewielki projekt do którego koniecznie potrzebujesz dokumentacji w języku Polskim bądź Angielskim to może będę w stanie na próbę takią zrobić :)
[UŻYTA TEMPLATKA]

### Code Snippet Documentation: [Script Name]
**File:** [file_name + extension] (e.g., `script.py`)
**Description:**
A concise description of what the script accomplishes.
#### Usage:
Provide instructions on how to use the script, including required inputs or parameters.
#### Functionality:
Describe the primary functionality and purpose of the script.
#### Notes:
Include any crucial notes or considerations for users regarding the script.

┏━━━━━━━━━━━━━━┓
┃  GNU   ┃  Szmelc  ┃
┗━━━━━━━━━━━━━━┛
Obrazek zwinięty kliknij aby rozwinąć ▼

Generator dokumentacji

8
Siema, zna się tu ktoś coś na programowaniu / dokumentacji i tego typu sprawach?

Interesuje mnie automatyczne generowanie dokumentacji na podstawie kodu źródłowego, a najlepiej to całego projektu w raz ze strukturą i zależnościami / interakcjami plików :v

Póki co używam ChatGPT i do tej pory ułatwiłem sobie tylko tyle że mam skrypt który skanuje mi folder projektu i wypluwa surowy plik dokumentacji a raczej zawartości w którym jest struktura projektu (komenda tree) np:

/ścieżka/projektu
├── append.sh
├── DOC.md
├── DOC.pdf
├── DOCp.md
├── maker.tar.gz
└── project.txt
1 directory, 6 files
I pod spodem zawartość wszystkich plików po kolei w stylu: "Plik: xyz" "Zawartość: zawartość pliku xyz" i tak dalej.

Na sam koniec wrzucam to do CzatuGPT i poprzedzam templatką
Generator dokumentacji
Co sprawia że GPT wypluwa mi taki mniej więcej plik:

Ogólnie mam kilka wariantów templatek i sprawdzam różne podejścia do zapytań oraz metody przerabiania danych.
Generator dokumentacji
Ogólnie zrobiłem jeszcze templatkę do pojedyńczych plików z kodem, co wygląda tak o, oraz generuje output który jest bardziej szczegółowy co do 'mechanik' i działania kodu.
Generator dokumentacji
Generator dokumentacji
Ma ktoś pomysł jak to ogarnąć sprawnie, tanio i hurtowo?

Ogólnie robię testy na ChatGPT Web UI, jak już opracuję sposób to zainwestuję w API i puszczę to przez desktopowego bieda clienta którego napisałem a który zapisuje całą rozmowę w logu oraz pliki w codeblocku osobno.

Zastanawiam się jeszcze nad użyciem GitHub Copilot lub Tabnine zamiast GPT, w końcu mają integrację do IDE i całą masę bajerów dedykowanych tego typu zastosowaniom.

Jakieś sugestie?
Obrazek zwinięty kliknij aby rozwinąć ▼
0.1444718837738