manページの書き方 - 道ばたに仰ぐ
研究室で開発しているプログラムSLIMのmanページを作ってみた。以下メモ的なまとめ。 - manページの基本はhttp://www.linux.or.jp/JF/JFdocs/Man-Page.htmlにまとまっている。ひとつ、知っておくべき事はmanページは以下のようなセクション番号で分類されることだ。 番号 説明 1 コマンド(プログラム) 2 システムコール 3 ライブラリ関数 4 /dev以下のスペシャルファイル 5 ファイルのフォーマット 6 ゲーム 7 その他、仕様や慣習など様々な事 8 システム管理のコマンド manページを書くためには man(7), man-pages(7)を見れば良い。 $ man 7 man $ man 7 man-pages とコマンドを入力すれば見ることが出来る。どちらもセクション7のページで、man(7)はmanページのフォーマット，man-p
ソフトウェアのバグをなくすには？--プログラミングの際に避けるべき10の失敗
この疑問に対する答えにたどり着くまでの道筋は数多くあるが、ここでは現実的な答えを提示したい。その答えとは、プログラマーが過ちをおかすためというものだ。彼らは、時にいいかげんな作業をする。また彼らは、最適なツールや最適なプラクティスを常に選択するわけでもない。 筆者はカリフォルニア大学バークレー校の公開講座でオブジェクト指向プログラミングを教えており、ソースコードそのものに対する理解を助けるために費やす時間と同じくらいの（あるいはそれ以上の）時間をかけて、優れたプログラミングプラクティスとは何かを教えている。本記事では、この講座の学生らがしでかす数多くの過ちを紹介したい。 なお、本記事を執筆するにあたり、ノースウェスタンポリテクニック大学工学部のJames A. Connor教授に連絡を取り、同教授の学生たちがしでかす過ちを紹介してもらった。 ＃1：コメントの付け方が貧弱 コメントという要素
わかりやすいREADME.mdを書く
GitHubなどに自分のツールやライブラリを公開するとき，README.mdは重要な役割を担っている．レポジトリを訪れたユーザが自分のツールを使ってくれるか否かの第一歩はREADME.mdにかかっている，と言っても過言ではない．実際自分が使う側になったときも，まずREADME.mdを読んで判断していると思う． 成功しているプロジェクトを参考にしつつ，自分が実践していることをまとめておく．ここに書いていることはあくまで（自分の中で）最低限的なものである．プロジェクトが成長していくにつれてREADMEはあるべき姿に成長していくべきだと思う． READMEの役割 README.mdには大きく2つの役割がある． プロジェクト，ツールの使い方，インストール方法 プロジェクト，ツールの宣伝 元々READMEは前者の役割しかなかったが，GitHubの仕組み上，後者の役割も徐々に重要になっている． さらに
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
