卒論でプログラムの書き方って?

卒論でプログラムの書き方とは?
卒業論文(卒論)でプログラムを扱う場合、どのように記述すればよいのか悩むことがあるでしょう。
「コードはどの程度詳しく書くべき?」「ソースコードの掲載方法は?」など、疑問を持つ人も多いはずです。

今回は、卒論でプログラムを記述する際のポイントを詳しく解説します!
読みやすく、評価されやすい卒論を書くためのコツを押さえていきましょう。

1. 卒論でプログラムを書く目的を明確に!
まず、「なぜプログラムを書くのか?」を明確にすることが大切です。

卒論でプログラムを扱うケース
システム開発(アプリやWebサービスの開発)
データ分析(Pythonなどを使ったデータ処理)
シミュレーション(数値計算やモデルの実装)
アルゴリズムの研究(新しいアルゴリズムの提案・評価)

📌 ポイント:「コードは論文の補足」であることを意識する!
卒論の**主役はコードではなく、「研究」や「結果」**です。
「なぜこのコードが必要なのか?」を論理的に説明することが重要になります。

2. プログラムの書き方(本文編)
論文の本文でプログラムについて書く場合、以下の点に気をつけましょう。

📌 ① コードの意図を説明する
プログラムをそのまま載せるのではなく、「何を実現するコードなのか?」を明確にしましょう。

📍 NG例(コードをそのまま載せるだけ)

def factorial(n):
if n == 0:
return 1
else:
return n * factorial(n-1)
👉 これでは、何のためのコードなのか分かりません!

📍 OK例(説明を加える)

本研究では、再帰関数を用いて階乗(n!)を計算するプログラムを実装した。
以下のコードは、Pythonによる階乗計算の実装例である。

def factorial(n):
if n == 0:
return 1
else:
return n * factorial(n-1)
ここで、関数 factorial(n) は引数 n を受け取り、n が0の場合は1を返し、それ以外の場合は n * factorial(n-1) を再帰的に計算する。

📌 ポイント
✅ コードを載せる前に「何をするコードか」を説明する
✅ コードを載せた後に、簡単な解説を入れる

📌 ② 変数・関数名は分かりやすくする
卒論は「誰が読んでも分かること」が大事!
そのため、コード内の変数名や関数名は、できるだけ意味が伝わりやすいものを使いましょう。

📍 NG例(意味が分かりにくい変数名)

def f(x):
return x * 2 + 5
👉 何を計算している関数か分かりません。

📍 OK例(分かりやすい変数名)

def calculate_linear_function(x):
return x * 2 + 5
👉 何の計算をしているのか、一目で分かる!

📌 ポイント
✅ 「a」「b」「f」などの短すぎる変数名は避ける
✅ 関数名には具体的な処理内容を反映する

3. プログラムの書き方(卒論の構成編)
卒論にプログラムを含める場合、どのように配置すればよいのでしょうか?
一般的には、以下の方法を使います。

📌 ① 本文に簡単なコードを記載する
短いコード(10行程度まで)は、本文中に掲載してもOKです。
ただし、読みやすくなるように適切にフォーマットしましょう。

✅ 本文中のコードの例(Markdown形式)

public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
👉 論文では「コードブロック」形式にして、フォントを統一すると読みやすくなる!

📌 ② 長いコードは「付録」に載せる
プログラムが長くなる場合は、本文にすべて載せずに「付録(Appendix)」としてまとめるのが一般的です。

✅ 本文中の書き方(付録に誘導する)

本研究では、Webスクレイピングを用いたデータ収集プログラムを実装した。
実装コードの詳細は付録Aに記載する。

✅ 付録の書き方(Appendix)

付録A:データ収集プログラム
import requests
from bs4 import BeautifulSoup

url = "https://example.com"
response = requests.get(url)
soup = BeautifulSoup(response.text, "html.parser")

print(soup.title.text)
📌 ポイント
✅ 本文にはプログラムの概要のみを記載し、長いコードは付録に回す
✅ 「付録A」「付録B」などの形式で整理する

4. 卒論でのプログラムの評価方法
卒論では、「プログラムを作っただけ」では評価されません。
「そのプログラムがどのように機能し、どんな結果を生んだか」を示すことが重要です。

📌 評価のポイント
✅ プログラムの精度(エラー率・正確性)
✅ 処理速度(実行時間の比較)
✅ 他の手法との比較(既存技術との違い)
✅ 実験データの分析(グラフ・表を使うと分かりやすい)

👉 単なるコードの紹介ではなく、「実験結果」や「考察」を必ず入れる!

まとめ:卒論でのプログラム記述のポイント
✅ 「なぜこのプログラムが必要なのか?」を明確に書く
✅ 本文には簡単なコードのみを掲載し、長いコードは付録へ
✅ コードの前後に解説を入れて、意味が伝わるようにする
✅ 変数・関数名を分かりやすくする
✅ プログラムの実験結果や考察を必ず記載する

卒論では「プログラムを書くこと」が目的ではなく、「研究としての意義を示すこと」が重要です。
読み手にとって分かりやすいように、論理的に整理されたプログラムの書き方を意識しましょう!