パスワードを忘れた? アカウント作成
この議論は賞味期限が切れたので、アーカイブ化されています。 新たにコメントを付けることはできません。

コメントはソースコードを表す?」記事へのコメント

  • by Anonymous Coward on 2009年11月19日 13時43分 (#1675065)
    「○のために△をしている」や引数、戻り値の説明くらいなら良いですが
    自作のアルゴリズムの説明など文章で表現し難い、または表現しても読みにくい、
    図(AAではなく)で描けたらもっと分かりやすいのに・・・

    などと感じることがあります。

    こういう状態になること自体がダメなのでしょうか。
    • 1回だけ, AVL木のコーディングをした時にコードの横に対応する木の変形をAAで書いたことがあります.

      本当はglobal [gnu.org]みたいな感じで, コード中に対応する設計ドキュメントへのアンカーを埋め込めれば便利なんでしょうけど.

      親コメント
    • 昔はコードを書いてからコメントしてたが、今はコメント書いてからコードに変換してる。
      当然、アルゴリズムはコメントで説明し易いこと優先。

      --
      the.ACount
      親コメント
    • by Anonymous Coward
      図形的な処理のプログラムでコメントでAAっぽく書いたことはありますね。
      長々と説明するよりは図で見れば直ぐにわかるようなのはよくあります。
    • by Anonymous Coward
      既出にあるように図にすると簡単なのは図にするのが一番ですね。
      URLみたいなのでも貼ってやればいいのでは?と個人的には思う。
      (そのソースと同じフォルダに説明用のpngファイルを置くとか)
      まあ、ソースに図も置ける様にして欲しいと思う時はそんな場合ですね。

      #IDEだとビットマップの管理もできるからそれと同じ扱いで可能かな?

アレゲは一日にしてならず -- アレゲ研究家

処理中...