良い命名方法について

概要

プログラミングにおいて、変数名やクラス名などは読みやすく簡潔にするべきである。
これは、エンジニアがコードを書く時間より、コードを読む時間の方が長いことに起因する。
変数名やクラス名、関数名、インスタンス変数などエンジニアが読むべきコードはたくさん存在する。
それらについて、良いコードを書くための方法をここに記述する。

実論

命名がされていないコード

例えば、以下のコードが存在したとする。
このコードは、引数に渡された値の和が、偶数であるかどうかをboolで返すものである。
しかし、クラス名や、メソッド名、変数名が曖昧でパッと見て理解しにくいコードとなっている。

Warning

class Foo(){
	fun a(a: Int, b: Int): bool{
		val c = a + b
		
		if(c % 2 == 0) return true;
		else return false:
	}
}

命名がされているコード

このコードでは、クラス名や関数名が何を行うものかを分かりやすく表現している。

Success

class AudioPlayerController(){
	val audioPlayer = AudioPlayer()
	var isPlaying = false;
	
	fun play(musicPathArg: String){
		audioPlayer.play(musicPathArg)
		isPlaying = true
  }
  
  fun pause(){
  	audioPlayer.pause()
  	isPlaying = false
  }
  
  fun resume(){
  	audioPlayer.resume()
  	isPlaing = true
  }
}