PHPの開発環境を構築する（その6）： PHPDocumentorを試す | 悠雀堂ブログ
Javadoc（あるいはDoxygen）のように、PHPにもPHPDocumentorというAPIドキュメントを作ってくれるツールがあります。（DoxygenもPHPに対応しているようですが、PHP界ではこちらのほうがメジャーなようです。） 本稿では、PHPDocumentorをインストールして、実際に利用してみます。 （2014年12月23日追記：Pleiades All in One Eclipse 4.4 Luna PHP fullでのインストールについて追記しました。） （2015年2月26日追記：インストール方法については「Composerによるツールのインストール」を起稿しました。こちらをご参照下さい。） はじめに Eclipse+PDTを使っていると自動的にPHPDoc形式のコメントを生成してくれて便利です。 しかし実際にレポートを生成してみないと、コメントの仕方もわかりませ
phpDocumentorの書き方 - Qiita
phpDocumentorの書き方ってこれ！っていうベストプラクティスがなくて（ドキュメントとはそういうものなのかもしれないけど…）、毎回試行錯誤して、フォーマットを考えるだけでも時間を取られるので、一度自分なりのフォーマットをまとめたいと思います。 今回は、クラスとメソッドについてまとめています。 プロパティについても書いたほうがドキュメントとしてはよいと思うのですが、プロパティまで書き出すとなかなか継続出来ない（ダメ人間です）ので、追々。。 ちなみに、CakePHPをやんわり想定しています。 では、まずクラスについて。 クラス：フォーマット /** * [区分]クラスの概要 * * クラスの詳細 * 出来るだけ細かく書いたほうがよいが、詳細な説明は各メソッドに任せる。 * 全体での共通ルールとか仕様を書く。 * * @access アクセスレベル * @author 名前 <メールアド
【PhpDoc】コメントの書き方のまとめ – 小俣泰明(タイメイ)ブログ@アルサーガパートナーズ
関数/メソッドの場合 例文 /** * aaaの説明 * * @param string $arg 第一引数 * @param integer $arg2 第二引数 * @return array 戻り値の説明 */ function aaa($arg,$arg2){} 型 string integer object(オブジェクト) array mixed(いろんな型が返る場合), resource(リソース型) 変数/define定数 /** * 説明 * @see 関連関数 */ のように書きます。 クラスの場合 /** * クラスの説明 * * @package パッケージ名：ここは、自分でうまく分類作れれば見やすくなる * @author 作った人 * @since PHP 5.3 PHPのバージョンとかいれときます？ * @version 1.0.1 */ DocBlockとは？
「学芸員はがん。連中を一掃しないと」 山本地方創生相：朝日新聞デジタル
山本幸三・地方創生相が１６日、大津市内のホテルで開かれた滋賀県主催の地方創生セミナーで、文化財観光の振興をめぐり見学者への案内方法やイベント活用が十分でないことを指摘し、「一番がんなのは学芸員。普通の観光マインドが全くない。この連中を一掃しないと」と発言した。 学芸員は博物館法で定められた専門職員で、資料の収集や保管、展示、調査研究などを担う。今回の発言はセミナーでの講演後、滋賀県長浜市の藤井勇治市長から「インバウンド観光振興について助言を」と質問された際にあった。外国の有名博物館が改装した際のことを引き合いに出し、「学芸員が抵抗したが全員クビにして大改装が実現した結果、大成功した」などとも述べた。 セミナー後の記者会見で、山本地方創生相は「新しいアイデアに、学芸員は『文化財だから』と全部反対する。学芸員だけの文化財でやっていると、これから観光立国で生きていくことができない。『一掃』は言い
PostgreSQLで排他制約がめっちゃ便利！！ - そーだいなるらくがき帳
中国地方DB勉強会っていう控えめに言っても最高の勉強会があるんだけどそこで排他制約について教えてもらいました。 ikkitang1211.hatenablog.jp 排他制約って雑に説明すると重なりを拒否する制約です。 僕は使った事なかったのですが勉強会の中で事例紹介を受けて、めっちゃ便利だったのでここでご紹介します。 どんなときに使うの？ 実際にはどんなときに重なりを制御したいかというとよく使うのは次の2つ。 図面の重なり 時間の重なり 1つ目は幾何学的な図面を表現するときです。 実際にPostgreSQLは円や四角をSQLで表現できます。例えば地図上で特定の座標から半径100メートルの円を書き、その中に特定の円(場所)があればErrorにするような制約が書けます。 そもそもSQLで位置計算もめっちゃ便利なので是非使ってみてください。 soudai1025.blogspot.jp そして
Sphinxでドキュメント生成-PDF（Windowsでの始め方） - torutkのブログ
昨日の日記の続きです。 Sphinxでドキュメント生成（Windowsでの始め方） - torutkの日記 今日は、SphinxでPDF形式のドキュメント生成を行います。PDF形式に出力するには、TeX経由で行う方法とSphinxのrst2pdf拡張で行う方法があるようです。 SphinxでPDFファイル作成 — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会(Sphinx日本ユーザー会ドキュメントより） 上記ドキュメントの比較によると、rst2pdfがよさそうなので、これを使ってPDF出力の仕組みをWindowsに整えます。なお、昨日同様、インターネットに接続していないPCでも環境を整えられるよう、必要なものをダウンロードしインストールします。 Windows上でrst2pdfを用意する PythonのReportLab Toolkitモジュール rst2pdfが
Docker imageを用意してWindows/macOSでスムーズに同人誌を作った話（Sphinx編） - once upon a time,
こんにちは、ハイラルに移住したchezouです。最近は、Rから始まりRで終わる言語をよく書いています。 いよいよ明日に迫ってきた技術書典2ですが、お-13で技術書供養寺として頒布を行います。 内容は、僕の機械学習の実務におけるtipsとfastFMを使った推薦、@tokorotenさんのKickstarterの分析、@hagino3000さんのスプラトゥーンのデータマイニングということで盛り沢山です。初めての同人誌ですが、140ページを超えた薄くない薄い本になりました。 是非買いに来てください！ tl;dr 技術書を書くときに、LaTeXを含んだDocker image使ってCIでビルド出来るようにすると共同執筆が捗るよ 前回までのあらすじ 今回は、メンバーがWindowsの人とmacOSの人の混成チームであったこと、全員がPythonに馴染み深い人だったので、reStructuredTe
Pythonをやるときに参考になりそうな情報 - のんびりSEの議事録
最近あんまり触っていなかったので、久々にPythonをやろうと思ったときにいろいろ忘れてたり、新しく知ったりしたこともあったので、Pythonやるときに参考になりそうな情報をまとめました (但し、今回はデータ分析系のライブラリ関連は除いています) Pythonの言語仕様や基本等 概要 — Python 3.5.2 ドキュメントdocs.python.jp qiita.com www.python-izm.com 2系と3系の違い postd.cc qiita.com コーディング規約 はじめに — pep8-ja 1.0 ドキュメント ドキュメント生成 azunobu.hatenablog.com ドックストリング """ 3重ダブルクォートを使用して記載する。 ドックストリングに記述したテキストは関数やクラスオブジェクトの__doc__に保存される def hello(): """Out
jt_noSkeのダジャレが本気で不愉快
1自分にとって深刻なニュースであいつのダジャレが１位取ってると殺意が湧くぐらい不愉快。 たった今ほんとにむかついたのはこれ。 http://b.hatena.ne.jp/entry/toyokeizai.net/articles/-/167830 渋谷については 「十年以上やってて全然終わらないどころか次の構想と工事が始まる工事中地獄」 「工事が一段落付いた部分も便利になるどころか不便さが増してる」 っていう あのへん使わざるを得ないものとしては本当に死活的な不都合が起きてる問題で。 これまでもこれからも工事中の粗末な臨時通路や幕の下を通って通勤して 合理性のわからん不便になる一方の乗り換え強要される人間は忙しい時は鬱病みたいになるんだ。 実際的なあれの指揮者・設計者は誰なのか知りたいし 一度都民の前に引きずり出して説明させたいぐらいの話なんだよね。 そういう自分にとって切実なニュースで
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
今までずっと騙されてた!? 地図ではわからない、本当の国の大きさ
『jt_noSkeのダジャレが本気で不愉快』へのコメント
巨乳はつらいよ。胸の大きい人が秘めてる日常の苦痛
雑誌「ゲームラボ」休刊 | スラド