[トップページ] [星雲紀行] [MLXS] [WPGen] [自作音楽] [モデル] [vi/vim] [tips] [自己紹介]

プログラミング作法

目次

  1. このページは
  2. tips
    1. メソドロジー
    2. 16進数記法で意味のある言葉
    3. 命名規則
  3. プログラミング指針
  4. プログラミング手順
  5. プログラミング心構え
  6. 開発プロセス
    1. ユーザビリティテスト
    2. セルフ・マネジメント
    3. ビルド・リリース
    4. デスマーチ
  7. 用語
  8. 参考文献・参考ウェブページ
  9. 履歴

このページは

プログラミング作法についてのメモ、TIPS。

[content]

tips

メソドロジー

メソドロジー(方法論)だけでは何も作れない。
[content]

16進数記法で意味のある言葉

16進数でかける単語。
これらを利用するとデバッグ時に初期化した数から変化しているかどうか確認する事に使える。

  1. 0xbad
  2. 0xbabe
  3. 0xcafe
  4. 0xdead
  5. 0xbeef
  6. 0xface
  7. 0xfeed
  8. 0xdeadbeef
  9. 0xabadcafe
  10. 0xabadface
  11. 0xbabeface
[content]

命名規則

自分の命名規則として、ハンガリアン記法をベースに使う。
冗長な部分(ループ変数など)は省略してもよい。ルールはまだ不完全。
[content]

ハンガリアン記法

  • ハンガリアン規約による名前は3つの部分から構成される。
    変数名 = 一つ以上のプリフィックス + ベース型 + 限定子
  • MS 発端。
  • 利点
    • 多くの名前が標準的に決められているため、個別のプログラムや関数で覚えるべき名前が少なくて済む。
    • 個々人の命名による不正確になりがちな部分を正確に表現できる。
[content]

the Indian Hill C Style and Coding Standards

広い範囲のコーディングスタイルの規約。
シンプルでわかりやすい、常識的なスタイルになるので必須。

[content]

短縮形

一般的に短縮形が通じる言葉は短縮形を使う。
わかりにくい言葉には短縮形は使わない。
自分のルールだが、なるべく一般性を持たせているつもりで記載している。
短縮形意味
coordcoordinates, 座標系
srcsource, ソース
destdestination, ディスティネーション dst は可読性にかけるため使用しない。

[content]

プログラミング指針

主な方法

  1. フローチャート
  2. トップダウンプログラミング
  3. ボトムアッププログラミング
  4. 構造化プログラミング
  5. オブジェクト指向設計
どれかひとつに固執せず、もっとも適しているものを 適宜選べばよい。

[content]

プログラミング手順

ソフトウェアのライフサイクル

  1. 要求仕様書作成
  2. 機能仕様書作成
  3. コード設計
    • 主要アルゴリズム
    • モジュール仕様
    • ファイルフォーマット
    • データ構造
  4. コーディング
    1. プロトタイプ作成
    2. 不足部分の付加
  5. テスト
  6. デバッグ
  7. リリース
  8. 保守
    バグ修正
  9. 改定とアップデート
    はじめから繰り返す

[content]

プログミング心構え

プログラミングする時に時たま何も出来ないときがある。
そういったときでも何とかエディタを立ち上げて編集し出せば何とかなることがある。
それをはじめることが難しい。
http://japanese.joelonsoftware.com/Articles/FireAndMotion.html

[content]

開発プロセス

ユーザビリティテスト

定量的評価手法としては、アンケート調査。
定性的評価手法としては、ヒューリスティック(経験則)評価、ユーザビリティテスト(被験者が実行する過程を観察し、行動、発話からUIの問題点を発見する)。

参考: http://www.usability.gr.jp/whatis/evaluation_method.html

[content]

セルフ・マネジメント

自分ひとりでできるプロジェクトの改善の方法。
1. デイリービルドできるサーバをつくり、makefile を書く。cronも作る。ユーザビリティテストを自分で行う。
2. CVS とBTS をつくり、自分で運営する。
3. 自分で自分のスケジュールと仕様書を書く。うぬぼれた指摘のメールは送らない。事実のみ。
4. ネックの人物がいれば、バグを見つけたときに修正せずにバグの結果のみを報告する。 自身で気が付けば成長できる。成長したら一緒にできる。
5. 生産性を確保するためならカフェや会議室で仕事しても良い。絶対にメーラやチャットは常駐させてインタラプトの隙を自ら作ってはいけない。
6. これらのプロセスにこだわりすぎず、結果を出しつつ実行すること。

[content]

ビルド・リリース

ビルドは定期的にリリースすることで安定性を図ることが可能。 (不具合数・修正数・修正失敗数・未修正不具合数などをカウント)
また、QAチームをプロジェクトで設置することも重要。
ビルドをリリースするタイミングは多いと時間のロスになるが、 フィードバックにつながる。 この期間はトレードオフになるが一週間か隔週が一般的。

用語 ---- showstopper, blocker, showstopper bug : 致命的な不具合でリリースを妨げるバグ。

言葉定義
first build最初のビルド。
不安定だが早めにリリースしておくプロトタイピングという手法に使うことがある。
パッケージ化は困難。
バージョン番号はここからつける必要がある。
weekly build毎週のビルド。リリースに適した期間。
daily build毎日のビルド。
テストの自動化に成功したときには毎晩行うことができる。
また、自動化するまでにいたっていなくとも、
毎日ビルドが成功するかどうかを確認可能になる。
daily build サーバも作成しよう。
private buildビルド番号が管理されないビルド。
QAチームにはリリースしない。
milestone build大きな単位でのビルド。
QAチームの外に出るビルドと考える。
latest build最新のビルド。
文脈で安定な最新、weekly の最新などに注意すること。
stable build安定したビルド。
リリースしてしばらく時間がたった状態でないといけない。
テストの自動化が済んでいればその時間を短縮できるもしれない。
candidate buildリリースする候補のビルド。
freeze buildある箇所を凍結したビルド。
機能(feature)フリーズ、UIフリーズ、コードフリーズの順。
特にコードフリーズ後はレポジトリの管理をしないと大変な工数が必要になる。
release buildユーザにリリースするビルド。 release build, final build, gold build などという。
参考:http://www.atmarkit.co.jp/farc/rensai/build06/build06a.html
[content]

デスマーチ

デスマーチに関する事柄のメモ。

  • クライアントは自分の望むことを知らない。
    例えばかっこいい家がほしい、といったときにそれが 家具のメーカーであったり、表札であったり、詳細を自分が知らないことと、 一緒の原理で専門でなければ詳細を把握していないこと、を知る必要がある。
    同様にボキャブラリも異なることを知る必要がある。
    それが理解を助けるし、調査を入念に行う原動力になる。
    http://japanese.joelonsoftware.com/Articles/TheIcebergSecretRevealed.html
  • クライアントの何かのソフトウェアに対する評価はスクリーンショットの部分が大きい。
    例えばlinux の新しいディストリビューションの評価はデスクトップの背景 だったりする場合がある。
    また、プログラムの進捗も内容にかかわらず見た目が影響するときがある。
    昨日は目に見えないもの。
[content]

用語

[content]

参考文献・参考ウェブページ

  1. Coding Style 個人リスト。重宝
  2. JoelOnSoftware 著名なプログラマJoel 氏の興味深い考察集 日本語訳
    時間の空いたときにちょくちょく読みたい。
  3. C 実践プログラミング
  4. プログラミング作法

[content]

履歴

  • 2004/00/00 初版作成
  • 2006/03/11 修正
  • 2006/03/25 修正 Joel on software
[目次]
ご意見、ご感想、誤字、間違い等、お気づきの点がありましたら KGussan@Gmail.com まで連絡ください。
このウェブページの注意・免責事項 Copyright (C) 2004-2012 KGussan. [トップページ]
[PR:元国税局勤務の起業家向け、遺産相続の相談なら植村洋税理士事務所:一時間無料税理士相談。お気軽に。]