API design에 대한 책은 많지만 C#에 대해서 특화된 내용이 없어서 좀 아쉽던 차에
이런 강의를 보게 됨. 하지만 강의 내용은 평범하다.
보다가 기억에 남는 것을 간단히 정리함.
하지만 강의를 들어야 모든 내용을 이해할 수 있으니 필요하면 구입해서 듣는 것도 방법임.
[Naming]
사실 아래 Coding convention을 참고해도 됨
http://www.dofactory.com/reference/csharp-coding-standards
올바른? naming을 사용하는 것은 code readability나 maintenance를 위해 꼭 필요하다.
. 영어 단어를 사용하되 의미가 맞고 적절한 어순으로 사용하라.
. 아재들이 사용하는 헝가리안 표기법(Hungarian notation)은 사용하지 말라.
. C coding style 도 별로임. “i_cnt”, “str_name”.
. 변수, 함수 사용 시 짝을 맞춰 사용하라. (locked/unlocked, first/last 같이)
. private/protected field, parameters들은 Camel casing, 그외는 Pascal casing
. 약어는 2글자 이하는 모두 대문자로 3글자 이상은 casing을 따른다.
하지만 예외는 있음 : BitFlag(bitFlag), Email(email), Id(id), Ok(ok), Pi(pi), Metadata(metadata)
. 상속 받는 class들의 suffix를 따른다.
. 하나씩만 사용하는 enumeration은 단수형 이름으로 복수개를 한번에 사용할 수 있는 것은 복수형 이름으로...
무엇보다 code는 readable 하게 작성되어야 함.
댓글 없음:
댓글 쓰기