매개 변수 이름 지정 : 파일 이름 또는 파일 이름?
나는 내 이름에서 문법적으로 정확하도록 노력합니다 *. 나는 항상 filename
대신 fileName
. 자바 규칙도 이것을 사용하는 것처럼 보이지만 FxCop은 fileName
.
WikiPedia 에 대한 토론 이 있습니다 . 더 많이 읽을수록 내가 옳다고 느낀다 (매우 평범하다! :)). 누구에게 확실한 답이 있습니까, 아니면 단지 주관적인 것일까 요?
*이 게시물에 문법 오류가 없기를 바랍니다!
"파일 이름"또는 "파일 이름"은 영어로 쓸 수 있습니다. 이를 코딩으로 변환 할 때 "n"을 대문자로하거나 "n"을 대문자로 사용하지 않을 수 있습니다 (camelCase 또는 PascalCase 가정).
그건 그렇고, 당신은 질문에 문법 오류를 만들었습니다. 역설적이게도 문법 오류가 없다는 희망을 표현한 바로 그 문장에서 말입니다. "이 게시물에 문법 오류가 없기를 바랍니다!" 그러나 "errors"는 복수형이므로 "there 's"의 "is"는 주어 동사의 불일치를 나타냅니다.
*이 게시물에 문법 오류가 없기를 바랍니다!
필드 및 매개 변수 에는 낮은 낙타 케이스 가 권장됩니다.
예 1 :
fileName // for fields, parameters, etc.
FileName // for properties, class names, etc.
일반적으로 fileName
사용되며 NOT filename
; 엔터프라이즈 라이브러리 와 같이 Microsoft에서 만든 오픈 소스 항목의 소스 코드를 읽어 확인할 수 있습니다 .
이유 :
- 그 뒤에있는 요점 은이 경우 이름이 더 읽기 쉽다는 것입니다.
- 또한이 접근 방식 은 여러 매개 변수 (필드, 변수 ..)가 동일한 메서드 (class ..)에서 사용되며 동일한 접두사 "file" 이있는 경우 일관성을 추가 합니다.
- ... 몇 가지 다른 이유가 있지만 더 주관적입니다.
예 2 :
fileName, fileSize... // instead of filename AND filesize
참조 :
명명 규칙의 전체 집합을 보려면이 책을 확인하는 것이 좋습니다.
- Framework Design Guidelines : Conventions, Idioms and Patterns for Reusable .NET Libraries
(2nd Edition) by Krzysztof, published on Nov, 2008
(개인적으로 우리는이 책의 100 % 추천을 사용하지 않지만 전반적으로 꽤 좋은 지침이 있습니다)
또한 IDesign.net 에서 몇 가지 항목을 확인하십시오.
'filename'
이 단어가 'cow'또는 'chair'와 같은 단일 객체를 설명
'fileName'
한다고 가정하고 이것이 복잡한 객체 라고 가정하고 file이라는 객체가 있으며이 객체가 해당 파일의 이름을 설명한다고 가정합니다.
두 가지 철학적 접근 방식을 선택하십시오.
지금까지 내가 걱정으로,
thisIsMuchMoreReadable이 읽는 것보다.
여기에 대한 답변은 두 가지 문제에 걸쳐 있다고 생각합니다.
'FileName'대 'Filename'( 'name'은 별도의 단어 여야 함)
과
'fileName'대 'FileName'(첫 번째 문자는 소문자 여야 함).
대부분의 경우 저는이 단어를 하나의 전체 단어 '파일 이름'으로 취급하는 것을 선호합니다. 또한 더 쉬운 코드 완성 메뉴 탐색을 위해 소문자로 시작하는 변수 / 메서드를 선호합니다.
여러 단어로 된 이름을 구별하는 데 사용해야 할 낙타 대소 문자 문제도 여기에 있다고 생각합니다.
FxCop이 자동화 도구라는 분명한 대답이 아닙니까? "name"이 단어임을 인식하므로 대문자 N으로 시작하는 것을 제안합니다. "filename"도 단어라는 것을 알고 있으므로 첫 번째 F 만 대문자로 표시해야합니다.
파일 이름-길이 또는 제한된 문자 선택과 같이 운영 체제에 의해 부과 된 제한을 준수하는 전자적으로 저장된 컴퓨터 파일에 부여 된 식별 이름입니다.
과거에는 두 단어로 생각했지만 지금은 한 단어로 정의되어 있으므로
var 파일 이름 = ......
두 단어 였다면
var fileName = ....
여기에는 진정한 옳고 그름이있을 수 없습니다.
이것은 순전히 주관적이며 작업중인 커뮤니티와 완전히 관련이 있습니다. FxCop 및 StyleCop과 정기적으로 접하는 .net 코드가 fileName을 사용하는 경우 fileName을 사용하십시오. 다른 것을 사용하고 있다면 그 무엇이든 사용하십시오.
당신의 첫 번째 우선 순위는 아마도 당신 자신의 코드의 패턴과 일관된 다음 당신의 커뮤니티와 일관되어야합니다.
이 특별한 경우 .net Reflector는 fileName을 사용하여 많은 .net 코드를 보여 주므로 개인적으로 그 패턴을 사용하겠습니다.
당신이 자바 세계에 있었고 PMD와 checkstyle을 실행하고 그들의 api가 파일 이름을 자주 사용했다면, 나는 그것을 할 것입니다.
In addition to the wikipedia naming article, there is also The Practice of Programming by Kernighan and Pike. The first chapter in it touches on a lot of naming and code consistency issues.
If you are writing c/c++ there is a strong tendency to use names that people can actually read; i.e. filename is good, and so is yet_another_file_name (assuming you are not considering filename as a proper english word - I usually do).
참고URL : https://stackoverflow.com/questions/742115/parameter-naming-filename-or-filename
'IT박스' 카테고리의 다른 글
신속하게 NSCoder를 사용하여 enum을 인코딩하는 방법은 무엇입니까? (0) | 2020.11.25 |
---|---|
위도 및 경도 저장에 적합한 / 최적 유형 (0) | 2020.11.25 |
최고의 자바 트위터 라이브러리? (0) | 2020.11.25 |
RabbitMQ : 토픽 교환이있는 지속성 메시지 (0) | 2020.11.25 |
Service.onStartCommand에서 stopSelf ()를 호출 할 수 있습니까? (0) | 2020.11.25 |