project-mahiwa / mahiwa-frontend-go

mahiwaのGo言語向けフロントエンド
https://pkg.go.dev/github.com/project-mahiwa/mahiwa-frontend-go
MIT License
0 stars 0 forks source link

[✨Feature]: ドキュメント自動生成を実現する #21

Closed usuyuki closed 10 months ago

usuyuki commented 10 months ago

✨ 概要

コメントから生成できるとドキュメントの陳腐化を防げて大変良い.

なぜ必要

コメント→MarkDownできるツール探す.

備考

usuyuki commented 10 months ago

Goも自動でhttps://pkg.go.dev にドキュメントにしてくれる?

https://pkg.go.dev/github.com/usuyuki/nogolivi

usuyuki commented 10 months ago

https://www.twihike.dev/docs/golang-primer/documentation koreka

usuyuki commented 10 months ago

exampleの自動生成(とwebでの実行)もできるけど,テストをもとにするのでテストがないとだめ. 今回のやつだとテストが書けないので,難しい.

usuyuki commented 10 months ago

pkg.go.devはgithubリポジトリ名でアクセスすると生成してくれるようになる