node.js 앱의 코딩 스타일 가이드?

node.js 앱의 코딩 스타일 가이드? [닫은]

---

node.js에 대한 코딩 스타일 가이드가 있습니까? 그렇지 않은 경우 최고의 오픈 소스 노드 프로젝트에서 사용되는 새로운 스타일 은 무엇 입니까?

파이썬을위한 표준 코딩 스타일 가이드 인 PEP 8 라인을 따라 가이드 (또는 여러 가이드)를 찾고 있습니다. 나는 여기에 링크 할 가치가없는 다양한 JavaScript 가이드를 보았습니다 (주로 오래되었고 클라이언트 측 JavaScript를 대상으로 함). 흥미로운 node.js 스타일 가이드를 찾았습니다 .

코딩 스타일 가이드 또는 코딩 규칙에는 다음이 포함되어야하지만 이에 국한되지는 않습니다.

• 코드 레이아웃 : 들여 쓰기 (2 칸, 4 칸, 탭 등), 줄 바꿈, 줄 바꿈 등
• 공백 (예 : "함수 (arg)"대 "함수 (arg)"
• 세미콜론 또는 세미콜론 없음, var 선언, ...
• 이름 지정 (예 : do_this () vs. doThis (), var_name vs. varName, ...)
• node.js 및 JavaScript 관용구 (예 : == vs ===), 콜백의 첫 번째 인수는 오류 객체입니다 ...
• 의견 및 문서
• 린트 체커, 단위 테스트 프레임 워크와 같은 도구

이 주제는 분명히 주관적이지만, 성숙 과정에서 일반적으로 널리 인정되는 코딩 스타일을 확립하는 것이 커뮤니티의 중요한 단계라고 생각합니다. 또한 맛에 관한 것이 아닙니다. 특히 == "대신"=== 사용과 같은 규칙은 코드 품질에 직접적인 영향을 미칩니다.

---

JSLint 에서 확인한 코딩 표준을 검토 하거나 NPM (Isaac Shlueter) 코딩 표준 의 저자를 살펴 보았습니다 .

주목할만한 Node.JS 코더가 사용하는 스타일을 볼 수도 있습니다 :

• 티제이 할로 웨이 추크
• 아이작 슐 레터
• 팀 카스 웰
• 제레미 애쉬 케 나스
• 펠릭스 가이 센도 퍼
• 찰리 로빈스
• 마라 크 스콰 이어스
• 아론 헥만
• 기예르모 로흐
• 미칼 로저스
• Ryan Dahl + 실제 Node.JS 코드베이스를 볼 수 있습니다

나는 좋은 척도를 위해 거기에 내 것을 던질 것이다 ;)

편집 : @alienhard의 제안

• Google 자바 스크립트 스타일 가이드
• Felix의 Node.js 스타일 가이드

IMO 준수해야 할 몇 가지 황금 규칙이 있습니다.

• 절대 사용 with또는eval
• ===이상 사용==
• 항상 var적절한 범위에서 변수를 선언하십시오 -전역 범위로 대체하지 마십시오
• (function(){})()브라우저뿐만 아니라 서버 측에서 실행되는 코드를 릴리스하려는 경우 앱을 클로저로 감싸십시오.
• 콜백은 err첫 번째 인수로 취해야하며 콜백을 인수로 사용하는 경우 마지막이어야합니다. 예 :callback(err, param1, param2, callback)

들여 쓰기, 중괄호와 키워드 사이의 간격 및 세미콜론 배치는 모두 선호 사항입니다.

---

마을에는 새로운 표준이 있습니다.

표준 스타일을 사용하십시오 .

---

클라이언트 지향 JavaScript 가이드에서 많은 코딩 스타일 사례를 배울 수 있습니다 (클라이언트와 서버 측의 차이는 대부분 언어 자체가 아니라 라이브러리에 있기 때문에 대부분 node.js에도 적용됩니다). 예를 들어 JavaScript Patterns 책은이 주제에 대해 2 장의 일부를 설명합니다 . 또한 Douglas Crockford의 웹 사이트 , 서적 및 비디오 는 JavaScript 고유의 코딩 스타일과 모범 사례를 채택하기 위해 반드시 필요한 자료입니다.

---

터미널에서 노드를 사용할 때 소스 코드가 공백을 사용하여 들여 쓰기하는 것이 유용합니다. 그렇지 않으면 "error here"캐럿이 표시되지 않습니다.

탭 포함 :

        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

This might be a Mac only issue, but I would suspect not.

---

It has been a while since I asked this question... and in the meantime I've found this excellent JavaScript guide:

Principles of Writing Consistent, Idiomatic JavaScript

https://github.com/rwldrn/idiomatic.js/

---

Airbnb has a quite good Javascript style guide https://github.com/airbnb/javascript

---

For Coffee-Script, where bad indents means compilation errors

use

:set tabstop=2
:set shiftwidth=2
:set expandtab

popular coffee projects, zombie, brunch uses this setup for indentations.

Edit:

Actually, just use this! https://github.com/paulmillr/code-style-guides (one of the main contributors to brunch)

참고URL : https://stackoverflow.com/questions/5495984/coding-style-guide-for-node-js-apps