カミュプリィの雑多なメモ

タグ: わかりやすさ

  • [CGI]わかりやすさを目指して

    [CGI]わかりやすさを目指して

    　カミュプリィの『西暦・年齢・和暦・干支対照表』CGIを書くときに気を付けたところは「コードのわかりやすさ」です。

    どのようにわかりやすくしたか？

    　CGIはHTMLの内容を出力するプログラムです。表示された『西暦・年齢・和暦・干支対照表』でマウス右ボタンをクリックして「ページのソースを表示」で表示されたものを出力する処理をおこなっています。

    　それならCGIが出力するHTMLの内容をそのままファイルに保存しておくのが、もっとも全体がわかりやすくなるとおもい、ざっくり次の内容でテキストファイルを保存しました。

    <!doctype html>
<html dir="ltr" lang="ja" prefix="og: https://ogp.me/ns#" >
<head>
	<meta charset="utf-8">
	<title>西暦・年齢・和暦・干支対照表</title>
</head>
<body>
	<table>
		<caption>西暦・年齢・和暦・干支対照表</caption>
		<thead>
			<tr>
				<th>西暦</th>
				<th>年齢</th>
/* HEADER CREATE */
				<th ID="ETO">干支</th>
			</tr>
		</thead>
		<tbody>
/* TABLE CREATE */
		</tbody>
	</table>
<div class="indent">
</div>
</body>
<footer>
/* COPYRIGHT CREATE */
</footer>
</html>

    　『/* HEADER CREATE */』『/* TABLE CREATE */』『/* COPYRIGHT CREATE */』部分のHTMLが足りていませんので、干支や和暦の情報をもとにCGIが補います。CGIには静的なHTMLが一切含まれないことで、読みやすくなっています。

    甲子 （きのえね）
乙丑 （きのとのうし）
丙寅 （ひのえとら）
　・・・
    2019/05/01,令和
1989/01/08,平成
1926/12/25,昭和
　・・・

    　このCGIはPythonで作成しましたが、他の言語でも同様の工夫はできるのではないかとおもいます。