코드를 작성할 때 우리는 종종 '작동하는' 코드에만 집중하곤 합니다.
하지만 우리가 작성한 코드를 다른 사람이 읽거나 유지보수해야 할 때를 생각해보면, 가독성이 얼마나 중요한지 깨닫게 됩니다.
코드의 가독성은 개발자 간의 협업 뿐 아니라 코드의 이해와 유지보수를 위해 필수적입니다.
오늘은 명명 규칙에 대해 이야기해보려고 합니다. 명명 규칙은 코드의 가독성을 높이고 유지보수를 쉽게 만들어주는 중요한 요소 중 하나입니다. 특히, 유니티에서의 명명 규칙은 개발자들이 코드를 이해하고 확장하기 쉽도록 도와줍니다.
1. 파스칼케이스(PascalCase) 유니티에서는 대부분의 클래스나 인터페이스의 이름을 파스칼케이스로 작성합니다. 이렇게 하면 클래스나 인터페이스가 어디에서 사용되는지 한눈에 알아볼 수 있습니다.
2. 덩치가 크거나 public인 경우는 파스칼케이스 클래스나 메서드 등의 크기가 크거나 외부에서 접근 가능한(public) 경우에는 파스칼케이스를 사용합니다. 이렇게 하면 중요한 요소임을 알 수 있습니다.
using UnityEngine;
public class PlayerController : MonoBehaviour
{
// 덩치가 큰 클래스
public CharacterStats PlayerStats;
// 외부에서 접근 가능한(public) 메서드
public void MovePlayer(Vector3 direction)
{
// 함수 내부에서 사용되는 변수
float moveSpeed = PlayerStats.GetMoveSpeed();
// 함수 내부에서 사용되는 메서드
UpdatePosition(direction * moveSpeed);
}
// 외부에서 접근할 필요가 없는(non-public) 메서드
private void UpdatePosition(Vector3 newPosition)
{
transform.position = newPosition;
}
}
3.Non-public인 경우는 _+ 카멜케이스 그러나, 외부에서 접근할 필요가 없는(non-public) 경우에는 밑줄(_)과 카멜케이스를 사용하여 명명합니다. 이는 해당 요소가 내부에서만 사용되는 것임을 명확히 합니다.
4. 함수 내부에서 사용되는 것들은 카멜케이스 함수 내부에서 사용되는 변수나 메서드는 카멜케이스를 사용하여 명명합니다. 이렇게 하면 해당 변수나 메서드가 함수 내부에서만 사용되는 것임을 알 수 있습니다.
public class CharacterStats
{
// 함수 내부에서 사용되는 변수
private float moveSpeed;
// 함수 내부에서 사용되는 메서드
public float GetMoveSpeed()
{
return moveSpeed;
}
}
5. 정리
using UnityEngine;
public class PlayerController : MonoBehaviour
{
// 파스칼케이스: 덩치가 큰 클래스
public CharacterStats PlayerStats;
// 파스칼케이스: 외부에서 접근 가능한(public) 메서드
public void MovePlayer(Vector3 direction)
{
// 카멜케이스: 함수 내부에서 사용되는 변수
float moveSpeed = PlayerStats.GetMoveSpeed();
// 카멜케이스: 함수 내부에서 사용되는 메서드
UpdatePosition(direction * moveSpeed);
}
// _ + 카멜케이스: 외부에서 접근할 필요가 없는(non-public) 변수
private void UpdatePosition(Vector3 newPosition)
{
transform.position = newPosition;
}
}
// _ + 카멜케이스: 외부에서 접근할 필요가 없는(non-public) 클래스
class CharacterStats
{
// 카멜케이스: 함수 내부에서 사용되는 변수
private float moveSpeed;
// 카멜케이스: 함수 내부에서 사용되는 메서드
public float GetMoveSpeed()
{
return moveSpeed;
}
}
댓글 영역