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
Doxygen+Graphvizでクラス図を自動生成する - 毛のはえたようなもの
卒論生成たけなわの皆さんお疲れ様です。終わった皆さんお疲れ様です。 卒論ページを埋めるためにクラス図を生成する必要がありましたので、メモです。 暇になったら加筆します。 クラス図とかソースコードの依存関係の図を自動生成したい ソースコードが先にあってUMLを作るためのツールは探すと有料がほとんど。 でもDoxygenとGraphvizを組み合わせると無料でできるらしい。 というわけで用意するものはDoxygenとGraphvizとソースコードです。C++、C、Java、Objective-C、Python、IDL、 PHP、C#、Dに対応しているそうです。 まずGraphvizとDoxygenを下記からインストールします。 Graphviz | Graphviz - Graph Visualization Software Doxygen すべてデフォルトでOK Doxygenの設定 楽天
flymake で YAML のシンタックスチェック - わからん
やりたいこと flymake で YAML のシンタックスチェックがしたい。 対処 ~/bin などのパス(emacs の exec-path)の通してあるところに、emacs-yaml-syntax-check という名前で以下のファイルを配置します。実行権限を付与して下さい。require している yaml は Ruby の標準添付ライブラリです。 #!/usr/bin/env ruby require "yaml" begin YAML.load(ARGF) rescue Exception => error warn error.message #=> syntax error on line 3, col 2: ` name: pattern' end scratch バッファで (executable-find "emacs-yaml-syntax-check") と書き、)
blockdiag を WindowsXP で動かす « Stop Making Sense
【重要】 (2011年6月追記) 清水川大先生がWindows版インストーラを作成されました。 Sphinx-User.jp – Windowsへのインストール(スタンドアロンインストール) 本記事の内容を実行するよりはるかに簡単なので、こちらのインストーラの使用をお薦めします。 「必要最低限のツールしか入れたくない」、「苦労してみたい」・・・などの特別な理由をお持ちの方は以下にお進みください。 # 本記事は、2010年12月末時点の状況を基に作成しています。 はじめに 年賀状作成のために久々に WindowsXP を起動したついでに blockdiag を動かそうとしたら、予想以上に手間がかかってしまい、難しさを痛感。 その時の手順を記録・再現しました。 今回は、次の方針でインストールを試みました。 OS は WindowsXP Windows系OSはコレしか持ってないので… Cygwi
概要 — Sphinx 1.1 (hg) documentation
ダウンロード このドキュメントはバージョン1.1 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#pocooチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。Pythonのプロジェクトのためのすばらしい機能を提供してきましたが、現在ではC/C++も既にサポートしています。また、他
Windowsへのインストール(スタンドアロンインストール) — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
注釈 Windows Vista以降で管理者権限が必要な場所へのインストールを行う場合は「右クリックして管理者権限で実行」してください。(管理権限は要求しないように作っています) If you need privilege to install on WIndows Vista or after, You need to install with administrator privilege (right click and choose one). これでパス設定を含めたインストールが行われます。 スタートメニューから、コマンドプロンプトを起動するか、「名前を指定して実行」で cmd と入力してみましょう。ウィンドウが表れたら、 python[Enter] とタイプします。インストールしたPythonのバージョンを表す文章に続いて、 >>> という文字が表示されればインストールは成功で
ツールを使ったドキュメント作成技法（前編） － ＠IT
特集：ツールを使ったドキュメント作成技法（前編） 価値のある開発ドキュメントを効率的に作成するには？ アバナード株式会社 市川 龍太（Microsoft MVP 2008 for XML） 2008/05/20 システム開発の現場では、さまざまなドキュメントを作成する必要がある。しかし昨今では開発の短期化に拍車がかかっており、ドキュメントを作成するための工数を十分に取れないことが多くなってきている。そこで本稿では、限られた工数の中で価値のある開発ドキュメントを効率的に作成するための技法について解説していく。 本題に入る前に、まずウォーターフォール型開発の各フェイズにおいて、一般的にどれだけのドキュメントを作成する必要があるのかについて以下の表にまとめてみた。
満足せる豚。眠たげなポチ。:業務システム開発でドキュメントを作ることについて
職場でここ３〜４ヶ月の間、システム再構成のためのドキュメント化プロジェクトというのを進めてきた。その中で『ドキュメントを書く』ということに対する意識が随分自分の中で変化したので、メモしておく。 まずは経緯から。 そのシステムは、いわゆるレガシーなシステムで、十数年来の歴史を持つ。これまで基盤が多少変わることがあっても基本的にソフトウェアアーキテクチャ（どのような単位で機能をモジュール化するか、どのように機能を抽象化し変化に対して柔軟にするか）に変わりはなく、作った当初の設計にツギハギしてメンテナンスを続けていた。 元々は、一体何をすれば増員以外の手段で開発量を上げられるかということを議論していた。現行のアーキテクチャのままでは求められる開発期間とバージョンアップのサイクルに対して近い将来限界を迎えることが明白であったためだ。 今のアーキテクチャや設計に問題があり、メンテナンス性を大いに損ね
Epydoc
Overview Epydoc is a tool for generating API documentation for Python modules, based on their docstrings. For an example of epydoc's output, see the API documentation for epydoc itself (html, pdf). A lightweight markup language called epytext can be used to format docstrings, and to add information about specific fields, such as parameters and instance variables. Epydoc also understands docstrings
LaTeX - A document preparation system
LaTeX – A document preparation system LaTeX is a high-quality typesetting system; it includes features designed for the production of technical and scientific documentation. LaTeX is the de facto standard for the communication and publication of scientific documents. LaTeX is available as free software. You don't have to pay for using LaTeX, i.e., there are no license fees, etc. But you are, of co
Texツールいろいろ大島さんページ
English version --> Programs and Utilities #### Utilities #### to Home Page ... 開発／保守を行なっています ... しばらく 開発／保守が行われていません ... オリジナルのコピーがあります ... 古くなりました ... 別のサイトへのリンクです m-filter ：メールのフィルタープログラム（解説） メーリングリスト運営でのウイルス除去目的などに適し、以下の機能を持っています。 添付ファイルをその拡張子に応じて削除する、あるいは、指定した拡張子以外のものを削除する。 このときファイル名はMIME encoding されていてもよい。 text/html の部分を削除する(ON/OFF)。 指定したContent Type以外の部分を削除する、あるいは許可する。 引用の行が指定した行数以上続くと、その部分
コスモインフォーメーションラボ, ソフト部品, オリジナル物理学論文集
[これは便利！生活情報の部屋] [これは便利！情報技術系の部屋] Info. for Everyday's Life Infor. for Information Technology ﾗｰﾒﾝ屋から旅行、暮らしの防犯、 パソコン周辺機器からセキュリティまで SoftLand[ソフトランド] TeX text Editor WTeXEdit How to Use：Q and A コスモオリジナル フリーウエア。 [物理学オリジナル論文集](日本語） 量子論・古典論の統一はできるか 「時空構造と存在の確定」の改訂版 Can We Unify the Theory of Quantum and Classical Mechanics? 新理論を公開。 [Physics Garden][物理学の庭園] 私なりの物理学上の諸問題の解釈と解説。いろい
子供たちと珠洲とTeXと
この Web ページは自由にリンクして頂いてかまいません。 リンクもトップページ以外の任意のページに行って頂いても大丈夫です。 事後で構いませんから，私まで連絡を頂けると嬉しいです。
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
はてなブログ | 無料ブログを作成しよう
File: README — Documentation for gregbell/active_admin (master)
ブロック図生成ツール blockdiag — blockdiag 1.0 ドキュメント
Loading...
Bitbucket | Git solution for teams using Jira
Japan.internet.com Webビジネス - 使ったことのない最高の無償サービスOfficeスイートZoho
よねさんのWordとExcelの小部屋