[Python]Doxygen使ったメモ

Doxygen使ってみた。
その際に引っかかったところを簡単に。

まずDoxygenの使用に関しては以下のページ辺りを見てください。
Doxygen
Doxygen を使おう
doxygenで、各種形式のドキュメントを作ってしまおう
特殊コマンド

今回日本語でドキュメント（？）を作るということになり、日本語でコメント書きました。
ソースコードに日本語使うなんて久しぶりすぎて違和感たっぷり。。。
ただこれは僕だけが見るわけじゃない（ということになっている）ので、わからないもの書いても仕方ないと訳で、おれ日本人！といわんばかりの日本語コメントです。
次は出来れば英語にしたい、、、
目指せ英語力強化。

まずそのままソースに日本語書くと、Python動かない。
なんか引っかかります。
このときは、ソースのエンコーディングを指定してやらないとダメっぽい。
どうやって指定するかと言うと、

ソースに
# -*- coding: utf-8 -*-
と記述。
僕はとりあえず1行目に書いてます。

Unix系OSの場合はどうするんだろ、#! /usr/bin/python　の方が先なのか、後なのか、、
謎です。

一応これを1行目に書いてやればMayaからは実行できます。

ほんでこれをdoxygenに通してドキュメントを作成します。
で、作成されたHTMLを見るとー、、、文字化け。
日本語箇所が文字化け。

入力も出力もutf-8にしてるのになぜかなー、と思ってたら、テキストデータの文字コードをutf-8にしていないことを思い出して、変更してみました。
文字コードの変更は各々お使いのエディタによって違うと思いますので、各自調べていただくとします。

そして再度doxygenでドキュメントを作成すると、
ｷﾀｺﾚ、大成功。

つまり、doxygenで日本語を扱う際は十分気をつけてください、ということでした。
あとPythonでも日本語コメントは十分に気をつけましょう。
でもこれって何か回避方法あるのかね。
なにかご存知の方がいらっしゃるなら是非ご教授願います。

今まで日本語とかPrintにすら使わなかったから、日本語の扱いで悩むなんて考えたこともなかった。

にしてもDoxygenすごいですねーーー。
ズバーーーッとドキュメント作成してくれる。
docstringに記述すると特殊メソッド使えないのは残念ですが、まぁ仕方ない。
##で書けば特殊メソッドも問題なく使えるし、とりあえずこれで。

関数とかの意味メモっとくだけでも便利なんじゃないかと思いました。
これは常用するかも。

C++とかJavaとか、潰しが利くのもうれしい話。

しばらくは、とりあえず使う、ってぐらいで活用します。