HackMD - Collaborative Markdown Knowledge BaseGet everyone on the same page with Markdown Real-time collaborate on project team technical personal documentation in markdown. Capture fleeting ideas and formalize tribal knowledge.
Docstringを書こう！
自分が昔書いたコード、チームメイトが書いたコードがなにしているのかわからない...そんなことってよくありますよね。今回はそんな悩みを少しでも解決するため、コード内に書くドキュメントdocstringの書き方やドキュメントの自動生成方法を紹介していきます。Read less
Clear, Functional C++ Documentation with Sphinx + Breathe + Doxygen + CMake - C++ Team Blog
Clear, Functional C++ Documentation with Sphinx + Breathe + Doxygen + CMake Writing good documentation is hard. Tools can’t solve this problem in themselves, but they can ease the pain. This post will show you how to use Sphinx to generate attractive, functional documentation for C++ libraries, supplied with information from Doxygen. We’ll also integrate this process into a CMake build system so t
Doxygen vs. Sphinx+Breathe
ソースコードに埋め込まれたコメントから文書を生成するツールとして，DoxygenとSphinx+Breatheについて検討し，Doxygen単独での利用が妥当と結論づけた。そのことについてメモしておく。 一連の考察は以下でまとめたツイートがベースとなっている。 Doxygen vs. Sphinx+Breathe – Togetterまとめ Introductionソフトウェアを開発していると，そのソフトのクラスの構成や使い方，概念などが複雑になってくることがある。また，会社など複数人で開発を行っていると，新しく参加する人のためであったり，数年後に忘れた時のために，APIの説明文書（API文書）があるととても役に立つ。 しかし，こうしたAPI文書を作成する労力は無視できない。また以下の点も文書整備の妨げとなるだろう。 ソフトウェアの更新。 文書整備の優先度の低さ。 こうした問題があるため，
Markdown スライド作成ツール『Marp』の開発経緯裏話 - Speee DEVELOPER BLOG
2019/08/03 追記: 2019年現在、デスクトップアプリ版の Marp はすでに開発を中止しており、次世代版である Marp Next の開発に注力しています。デスクトップアプリはまだ使用可能ですが、すでにメンテナンスが中止されており、セキュリティに関する一部懸念も指摘されているため、デスクトップアプリ版をこれから使い始めるのは決して推奨されません。 移行先として、Marp Next の公式ツールの1つとして提供されている Visual Studio Code の拡張機能、Marp for VS Code をお勧めしています。クロスプラットフォーム・オフライン対応・ライブプレビュー・PDF出力はもちろん、新しい Marpit フレームワーク をベースとした Markdown 構文、HTML 形式や PowerPoint 形式での出力、カスタムテーマ CSS の対応など、スライド作成
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ドキュメントを作りたくなってしまう魔法のツールSphinx
