[B! python][ドキュメント] igrepのブックマーク

igrep id:igrep

pythonとドキュメントに関するigrepのブックマーク (2)

Pythonプロジェクトのdocstringの網羅率を計算するパッケージdoc-covをつくった - ぴよぴよ.py
みんなのdocstring書くモチベーションをあげるために、docstringの網羅率を計算して Pull Requestごとにdocstringの網羅率(coverage)の変化を表示したいな〜と思って調べたんですが、そういった網羅率を計算するライブラリが見つけられなかったので、自分で作りました。インストールの仕方と使い方を紹介します。インストール pip install doc-cov これでdoccovコマンドが使えるようになります。使い方基本的には計算したいプロジェクトのパスを指定するだけ。デフォルトではpublicな関数のdocstringの網羅率が出力されます。 $ doccov tests/sample_project function 3 / 5 60.00% Options 細かいオプションはREADMEにありますが、いくつか例を出しておきます。 csv出力
igrep 2019/02/07
python

ドキュメント
リンク
Doxygen
ソースコード・ドキュメンテーション・ツール Doxygen は、C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風)、Fortran、VHDL、PHP、C# 向けのドキュメンテーション・システムです。 D にもある程度対応しています。 Doxygen には、次の３つの利点があります。文書化されたソースファイルのセットから、オンライン・ドキュメント・ブラウザ (HTML形式) やオフラインのリファレンス・マニュアル (形式) を生成することができます。 RTF (MS-Word)、PostScript、ハイパーリンク PDF、圧縮 HTML、Unix man ページ形式の出力もサポートされています。ドキュメントは、ソースから直接抽出されます。これにより、ドキュメントとソースコードの一貫性を保つことがとても容易になります。 Doxyge
igrep 2011/08/06
jsdocとかjavadocとかrdocとかsphinxとかと似たようなものかしら。graphvizと連携できるらしい

java

PHP

C

C++

Python

Java

C#

ドキュメント
リンク
1