聞こえないJavaエンジニアが適当に書き連ねていく

つらつらとメモしたり日頃の溜まっている想いを吐き出す場所です。

プログラミングと執筆

プログラミング言語とあるのだからJavaCOBOLC言語も日本語や英語と同じ言語と言える。文法が違うだけ。

言語なので、プログラミングイコール執筆、または作文と同一なのではないか。

文章にするときは起承転結や全体の構成が大事。それはプログラミングでも同様で、まず処理全体の構成を考えて、それから内容を詰めていく。

変数名イコール文章内での言葉の使い方であり、適切な言葉を使うことでその文書全体の読みやすさ、伝わりやすさが変わってくる。

プログラマーイコールインタビュー、または編集者と考えられる。プログラミングは相手が伝えたいことを形にするもの、インタビュー記事は相手が伝えたいことを文章にするもの、出来上がるものは違うけどやりたいことは同じなのでは。

パッケージング&クラス名イコール索引であり、目的のところにたどり着くための手がかりである。適当にパッケージングして、適切なクラス名をつけると、書いている時は覚えているかもしれないが、後から読む人にとっては手掛かりがないので読めない。

コメントイコール注釈であり、仕様説明用のコメントイコール図解である。注釈が多い文書は読みにくいし、図解がない文書は読みにくい。

フォーマットイコール段落であり、段落がガタガタな文書は読みにくい。

 

一人で書くプログラミングでも、今プログラムを書いている時に読めていたコードが数日後の自分も読めるかは非常に怪しいものがある。

チーム開発は赤の他人が集まって行うものなので、他人が読みやすいものになっているかを充分に意識して書かないといけない。