コード ドキュメンテーションは、プログラマーがコードを文書化するプロセスです。 エンジニアの間ではよく知られた言葉です。
コード ドキュメントは、主にシステムがどのように動作するかを目的としているため、プロジェクト ドキュメントとは異なりますが、この 2 つのプロセスには共通点があり、専門的なツールを使用することが必要です。 この記事では、コード・ドキュメントを作成するためのいくつかの一般的なツールを概観します。
LaTex
LaTeX は、高品質のタイプセットのためのドキュメント作成システムです。 中・大規模の技術的あるいは科学的な文書に最もよく使われますが、 ほとんどすべての形式の出版に使うことができます。 その代わり、LaTeXは著者がドキュメントの外観を気にしすぎず、正しい内容を得ることに集中することを奨励します。
LaTeX は高品質のタイプセットシステムで、技術文書や科学文書の作成のために設計された機能を備えています。 LaTeX は、科学的文書のコミュニケーションと出版のためのデファクトスタンダードです。 LaTeX はフリーソフトウェアとして利用できます。
LaTeX を使用するためにお金を払う必要はありません。 例えば、ドキュメントのメタデータ（タイトル、著者、日付）、脚注、テーブル、定義リスト、上付き文字と下付き文字、取り消し線、拡張された順序付きリスト（開始番号と番号付けスタイルは重要です）、実行例リスト、構文強調表示付きの区切りコードブロック、スマート引用、ダッシュ、省略、HTMLブロック内のマークダウン、そしてインラインLaTeXです。
テンプレートシステムやフィルタを書くための強力なシステムなど、あなたのニーズに合わせて Pandoc をカスタマイズする多くの方法があります。 ライブラリは入力と出力のフォーマットごとに別々のモジュールを含んでおり、新しい入力または出力フォーマットを追加するには、新しいモジュールを追加するだけです。
Pandoc は GPL の下でリリースされているフリーソフトウェアです。 Markdown では、読みやすく、書きやすいプレーン テキスト形式を使用して書き、それを構造的に有効な XHTML (または HTML) に変換することができます。
Markdown のフォーマット構文の最優先の設計目標は、可能な限り読みやすくすることです。 Markdownでフォーマットされたドキュメントはタグやフォーマット指示でマークアップされたように見えることなく、そのままプレーンテキストとして公開することができるという考えです。 Markdownの構文はいくつかの既存のテキストからHTMLへのフィルターから影響を受けていますが、Markdownの構文に対する唯一最大のインスピレーション源は、プレーンテキスト電子メールのフォーマットです。
LiveEdu
LiveEdu では、あなたのコードドキュメントを放送して「動画コードドキュメント」を作成できます。
Education Ecosystemは分散学習システムで、実際の製品を構築する方法を専門家や大学生に教えます。 私たちの製品は、PluralsightとTwitchのハイブリッドと表現することができます。 私たちは、人工知能、サイバーセキュリティ、ゲーム開発、データサイエンス、暗号通貨、プログラミングなどの未来のテクノロジートピックのための世界最大の学習エコシステムを構築しています。 Education Ecosystemはビデオベースで、各プロジェクトにはビデオ、構造化されたプロジェクトのアウトライン、プロジェクトレポ、ダウンロード可能なリソースが含まれています。 ユーザーは、Education Ecosystem Git からプロジェクトリソースをクローンし、ローカルマシンでアプリケーションを実行できます。
Sphinx
Sphinx は、知的で美しい文書を簡単に作成できるツールで、Georg Brandl によって書かれ BSD ライセンスの下でライセンスされています。
これはもともと Python 文書のために作られ、一連の言語でのソフトウェアプロジェクトの文書のために優れた設備を持っています。 以下はいくつかの機能です:
- 出力フォーマット。 HTML (Windows HTML ヘルプを含む)、LaTeX (印刷可能な PDF 版)、ePub、Texinfo、マニュアルページ、プレーンテキスト。
- 豊富な相互参照：関数、クラス、引用、用語集、同様の情報に対する意味的マークアップと自動リンク。
- 階層構造：ドキュメントツリーを容易に定義し、兄弟、親、子への自動リンクが可能。