みかみんのプログラミング日記

文章で説明することの難しさ

こちらに書くのは久しぶりになってしまいました。ずっとプログラミング道場のほうの記事を書いていました。それで思ったのが、文章で説明することの難しさです。

特に、プログラミングに関することを書く場合は、コードがあります。プログラマーにとってコードは、時には文章以上の表現力があります。また、コード中のコメントというものもあります。短い的確な説明をコメントに書ければ、これも文章以上です。

今までは、掲載するコードが長くなるのを嫌って、コメントはまったく入れていませんでした。最近になって、自分の文章能力の低さを痛感し、もっとコメントを入れようかなと今更ながら思うようになりました。

結局の所、文章とコードとコメントの配分の問題なんですよね。うまく配分が取れれば一番いいんですが、それがなかなか難しい。

それに加えて、コードを整形する作業、C#からVB.NETへ変換する作業などなど、やることがいっぱいで、１つの記事を書くのに半日かかってます。また、あとから読み返して、気になるところをちょこちょこ修正するのはしょっちゅうです。なので、最終更新日を表示するのをためらっている状況です。

記事の閉め方も難しいですね。この記事もどうやって閉めようかずっと悩んでいます。

2014年1月12日