루비의 표준 파일 이름 지정 규칙

Question

주어진 클래스 인 SomeCoolClass가 포함 된 파일의 경우 적절하거나 표준 파일 이름은 무엇입니까?

 1. somecoolclass.rb
 2. some_cool_class.rb
 3. some-cool-class.rb
 4. SomeCoolClass.rb

아니면 다른 변형?

Ruby stdlib에서 버전 1, 2 및 3이 사용됩니다.

Answer 1

그냥 루비 (즉, 레일이 아님), 이름 지정은 단지 협약 일뿐입니다. ~ 안에 울타리 그만큼 협약 밑줄을 사용하는 것이 필요합니다 (거의).

나는 컨벤션 #2를 생각합니다 lowercase_and_underscore.rb 기사는 더 일반적이며 꽤 좋아 보인다. 여기 말한다 lowercasenounderscore.rb 루비 컨벤션입니다.

중 하나를 선택하십시오 어느 컨벤션이 더 일반적이거나 당신이 더 좋아하는 사람이 더 많습니다. 가장 중요한 것은 프로젝트 내에서 일관성을 유지하십시오.

Answer 2

밑줄이있는 소문자를 권장합니다 (질문에서 2 번). 이 이름 지정 체계는 레일의 협약이며 비 레일 프로젝트에서는 필요하지 않다는 것은 사실입니다. 그러나 대부분의 루비 프로그래머는 어쨌든 레일에 독점적으로 루비를 사용하고 있기 때문에 여전히 Rails 컨벤션을 고수 할 것입니다.

Answer 3

나는 개인적으로 단어 분리기로서 하이픈이 일반적으로 최대의 가독성과 유형을 만들어 낸다고 생각하므로 가능한 경우 (일부 컨텍스트에서는 대부분의 언어의 식별자와 같이 하이픈을 사용할 수 없음)를 권장합니다. 명심해야 할 중요한 한 가지 중요한 점은 선택한 계획이 사용자가 LIB와 함께 사용할 요구 사항에 맞추고 원하는 것입니다. 도서관 이름과 다른 보석 이름을 피하십시오.

나쁜

# gem install my_cool_lib
require 'my-cool-lib'

# gem install MyCoolLib
require 'my_cool_lib'

좋은

# gem install my_cool_lib
require 'my_cool_lib'

# gem install my-cool-lib
require 'my-cool-lib'

불행히도, 소수의 소수의 라이브러리는이 간단한 유용성 규칙을 위반합니다. 그 라이브러리 중 하나가되지 마십시오. :)

Answer 4

my-proj
├── README
├── lib
│   └── some_cool_class.rb
└── test
    └── some_cool_class_test.rb