node.js 앱에 대한 코딩 스타일 가이드?
node.js에 대한 코딩 스타일 안내서가 있습니까?)가 있습니까?그렇지 않다면 상위 오픈 소스 노드 프로젝트에서 사용되는 새로운 스타일은 무엇입니까?
PEP 8의 줄에 따른 가이드(또는 여러 가이드), Python의 표준 코딩 스타일 가이드를 찾고 있습니다.저는 다양한 자바스크립트 가이드가 여기서 링크할 가치가 없는 것을 보았습니다. (대부분 오래되고 클라이언트 쪽 자바스크립트를 대상으로 함)흥미로운 node.js 스타일 가이드를 찾았습니다.
코딩 스타일 가이드 또는 코딩 규칙에는 다음이 포함되어야 합니다(이에 제한되는 것은 아닙니다).
- 코드 레이아웃: 들여쓰기(2칸, 4칸, 탭 등), 새 줄, 줄 바꿈 등
- 공백(예: "function (arg)" vs "function (arg)"
- 세미콜론 또는 세미콜론 없음, var 선언, ...
- 이름 지정(예: do_this() vs. doThis(), var_name vs. varName, ...
- node.js 및 자바스크립트 숙어(예: == vs.===, 콜백의 첫번째 arg는 오류 개체입니다. ...
- 코멘트 및 문서화
- 보풀 검사기, 단위 테스트 프레임워크와 같은 부속 도구들...
이 주제는 분명 주관적이지만 성숙해지는 과정에서 공통적이고 널리 받아들여지는 코딩 스타일을 정립하는 것이 공동체의 중요한 단계라고 생각합니다.또한, 그것은 단지 맛에 관한 것이 아닙니다.특히 "== 대신 === 사용"과 같은 규칙은 코드 품질에 직접적인 영향을 미칩니다.
저는 JSLint에서 확인한 코딩 표준을 검토하거나 NPM(Isac Shlueter's) 코딩 표준의 저자를 살펴보겠습니다.
주목할 만한 노드에서 사용하는 스타일도 볼 수 있습니다.JS 코더:
- TJ 홀로웨이척
- 아이작 슐루터
- 팀 캐스웰
- 제레미 아슈케나스
- 펠릭스 가이젠더퍼
- 찰리 로빈스
- 마라크 스콰이어스
- 에런 헤크만
- 기예르모 라우흐
- 마이컬 로저스
- Ryan Dahl + 실제 노드를 볼 수 있습니다.JS코드베이스
편집: @alienhard의 제안
IMO 당신이 지켜야 할 몇 가지 황금 규칙이 있습니다.
- 사용 안 함
with아니면eval - 사용하다
===위에== - 항상 변수를 다음과 같이 선언합니다.
var적절한 범위에서 - 글로벌 범위로 후퇴하지 않음 - 앱을 닫힘 상태로 감습니다.
(function(){})()브라우저에서뿐만 아니라 서버측에서 실행되는 코드를 릴리스할 계획인 경우 - 콜백은 다음을 수행해야 합니다.
err첫 번째 주장으로서 그리고 만약 그들 자신이 주장으로서 콜백을 받아들인다면, 그것은 마지막이어야 합니다, 예를 들어.callback(err, param1, param2, callback)
들여쓰기, 괄호와 키워드 사이의 간격, 세미콜론 배치는 모두 선호도의 문제입니다.
마을에 새로운 기준이 생겼습니다.
표준 스타일을 사용합니다.
클라이언트와 서버 간의 차이가 언어 자체가 아닌 라이브러리에 있기 때문에 대부분 node.js에도 적용됩니다.예를 들어, JavaScript Patterns 책은 이 항목에 대해 설명합니다. 이 항목은 2장의 일부입니다.또한 더글러스 크록포드의 웹사이트, 책, 비디오는 자바스크립트 특유의 코딩 스타일과 베스트 프랙티스를 채택하기 위해 꼭 봐야 할 자료입니다.
터미널의 노드를 사용할 경우 소스 코드에서 들여쓰기 공간을 사용하는 것이 유용합니다.그렇지 않으면 "여기 오류" 캐럿이 줄을 서지 않습니다.
탭 포함:
var preps = files.map(function(f) {
^
TypeError: Cannot call method 'map' of null
공백 포함:
var preps = files.map(function(f) {
^
TypeError: Cannot call method 'map' of null
이것은 Mac만의 문제일 수도 있지만, 저는 그렇지 않을 것이라고 생각합니다.
제가 이 질문을 한 지가 꽤 됐습니다.그 사이에 훌륭한 자바스크립트 가이드를 찾았습니다.
일관성 있고 관용적인 자바스크립트를 쓰는 원리
https://github.com/rwldrn/idiomatic.js/
Airbnb는 꽤 좋은 자바스크립트 스타일 가이드 https://github.com/airbnb/javascript 를 가지고 있습니다.
Coffee-Script의 경우, 잘못된 들여쓰기는 컴파일 오류를 의미합니다.
사용하다
:set tabstop=2
:set shiftwidth=2
:set expandtab
인기있는 커피 프로젝트,zombie,brunch들여쓰기의 경우 이 설정을 사용합니다.
편집:
사실 이거 써봐요.https://github.com/paulmillr/code-style-guides (주요 기여자 중 하나입니다.brunch)
언급URL : https://stackoverflow.com/questions/5495984/coding-style-guide-for-node-js-apps
'programing' 카테고리의 다른 글
| 클래스가 같은 원소의 개수는 어떻게 셀 수 있습니까? (0) | 2023.11.02 |
|---|---|
| 앱이 독립 실행형 상태인 경우 PWA 앱에서 Facebook 로그인이 작동하지 않음 (0) | 2023.11.02 |
| 텍스트를 태그로 래핑 (0) | 2023.11.02 |
| 사전 키가 열 레이블인 다중 인덱스 데이터 프레임에 중첩된 사전 (0) | 2023.11.02 |
| jQuery 토글 CSS? (0) | 2023.11.02 |