개인프로젝트에서 결정해야하는 사안이 생기면 그냥 혼자 결정하시나요?

emptynote의 이미지

개인프로젝트에서 결정해야하는 사안이 생기면 그냥 혼자 결정하시나요?

개인 프로젝트 혼자 하는것이기때문에 혼자 결정하는거 맞지만 다른 분들 생각을 알고 싶어 미치겠네요.

IO 내용이 담긴 xml 파일로 부터 IO 를 처리할 자바 소스를 생성시키는 프로그램 작성중입니다.

정리하면 아래와 같습니다.

참고1) Echo.xml => Echo.java, EchoEncoder.java, EchoDecoder.java, EchoClientCodec.java EchoServerCodec.java

전통적으로 따르는 자바 이름 명몇 규칙이 있기때문에 아무 생각없이 메시지명은 대문자, 변수명은 앞글자 소문자 식으로 아래와 같이 처리를 했는데요.

(1) IO 내용에 대한 이름은 대문자로 시작되는 명사이다. 예) 클라이언트에서 보내는 메시지 그대로 받아 보는 메시지명 : Echo
(2) Value Object 인 Echo 의 자바 변수명으로 앞글자를 소문자로 만들었는데 그래도 될까요? 예) Echo -> echo

그런데 이런것들 제가 그냥 혼자 이렇게 정해도 되는걸까요?

mirheekl의 이미지


만약 존재하지 않는다면, 다른 개발자들과 함께 이번 기회에 만들어보는 것도 좋을 듯 합니다.

한번에 자세하게 만들 필요는 없고 말씀하신 부분을 커버하는 선에서 적당히 간단하게 만들어보면 어떨까요?

향후 가독성과 유지보수성을 위해서 꼭 필요한 작업입니다.

--

emptynote의 이미지


공감합니다.

다른 분들도 알아야 조언을 해 주실 수 있으니

시간을 내어서 꼭 정리를 해야겠네요.

emptynote의 이미지

자바 코딩 규칙 관련 사이트인데 참고할만하네요.

하지만 받아 들이기 어려운 항목도 있네요.

예를 들면 긴 이름을 피해라고 15자 정도를 권장하는데,

단축이라는것이 잘 줄여야 하는데,

영어가 짧은 제가 무슨 재주로 줄일 수 있을까요?

이런 단점을 알지만 부득이하게 단축 이름을 사용하는것이 시스템 내부적으로 사용하는 메시지인 SelfExn 가 있는데요.

Exn 은 Exception 의 단축명인데요.

SelfExn 메시지는 서버에서 발생한 예외(Exception)를 그대로 클라이언트로 옮겨 오기 위한 특수 메시지 입니다.

이 단축명은 제가 정한거지 다른분들도 모두 인정하는 단축명이라고 생각하지 않습니다.

그렇기때문에 단축하여 15자에 맞출려고 하는것에 회의적입니다.

하지만 The 이런거 붙여서 괜히 글자수 늘리는것또한 지향해야 한다는 점에서는 동의합니다.

참고 주소 : http://www.cwu.edu/~gellenbe/javastyle/index.html

mirheekl의 이미지

저도 그렇게 생각합니다. 약어를 동원해가며 억지로 줄이는것보다는 클래스나 메서드 설명에 도움이 되기만 한다면 50글자짜리 이름이라도 아무런 문제가 없다 봅니다. 어차피 요샌 툴이 좋아져서 그 이름을 직접 다 칠 일도 없고 말이죠.

결국 생각하시는 것과 마찬가지로, 남들이 하는걸 다 그대로 수용할 필요는 없습니다. 필요한 것만 받아들이면 되지요.

--