허용 된 코딩 스타일에 대해 알아 보는 방법

https://stackoverflow.com/questions/232975

04-07-2019
|

문제

개별 언어, 즉 이름 지정 변수 등의 규칙, 압입 및 버팀대 배치 위치, 댓글을 포함 할 방법 및 위치 등의 규칙, 즉 개별 언어에 대한 읽기 위치 (모범 사례) 소스 코드 서식

예를 들어 C Kernighan과 Ritchie의 책 C 프로그래밍 언어 그리고 Linus Torvalds ' Linux 커널 코딩 스타일 가이드 또는 Google의 C ++ 스타일 가이드 그리고 적어도 perl Perlstyle- Perl 스타일 가이드.

편집 : 아마도 "코딩 스타일로 좋은 시작을 얻는 방법"을 물었을 것입니다.

해결책

나는 그런 스타일 가이드를 너무 많이주지 않을 것입니다. 그들은 좋은 출발이지만 결국 당신이나 당신의 팀은 자신의 코딩 스타일을 개발할 것입니다.

편집 : Rob Kam은 이러한 '시작-수정'에 대해 더 자세히 알고 싶어한다는 의견을 제시했습니다.

그건 좋은 지적이야. 그러나 대부분 당신은 기존 프로젝트, 오픈 소스 프로젝트 또는 상업용에 가입 할 것이며, 그 일을하고있는 사람들은 이미 코드 컨버전을 가지고 있습니다. 회사에서는 아마도 이미 코드 협약이 존재할 것입니다. 새 프로젝트를 시작하면 이전에했던 다른 프로젝트의 컨벤션부터 시작하십시오.

이전에 사용하지 않은 새로운 언어로 새로운 프로젝트를 실제로 시작한다면 ... 어떻게 든 유사한 다른 언어의 컨벤션으로 시작할 수 있습니다 (즉, 새로운 OO 언어의 경우 Java 또는 Smalltalk의 컨벤션을 사용할 수 있습니다). 그리고 새로운 언어에 대한 경험을 얻을 때 규칙을 조정하십시오. Java에서 프로그래밍을 시작하면서 파스칼 코딩 컨벤션을 사용했습니다. Pascal-Conventions 중 일부는 Java에게는 효과가 없었지만 시간이 지남에 따라 오래된 규칙을 버리고 새로 발전했습니다.

S.Lott는 선택한 언어로 작성된 오픈 소스 프로젝트를 조사 할 아이디어가있었습니다. 좋은 컨벤션에 대한 제안을받는 것이 좋습니다. Srikanth는 StackoverFlow에서 좋은 컨벤션을 요청하는 것이 좋습니다. 시간이 지남에 따라 StackoverFlow가 이러한 방식으로 코딩 컨벤션에 대한 좋은 참조가 될 것이기 때문에 아주 좋은 생각입니다.

다른 팁

책보다 더 나은 것은 선호하는 언어로 오픈 소스 코드를 찾는 것입니다.

몇몇 저자와 편집자의 작품 인 책 대신 작업 소스 코드는 고도로 진화 한 커뮤니티 표준을 충족시키는 커뮤니티 프로젝트입니다.

클라이언트가 코딩 표준을 도와달라고 요청하면 좋은 오픈 소스 프로젝트를 찾아 "XXX처럼 보이게 만드는 짧은 표준 문서"를 제공하는 것이 좋습니다. 내가 Java 스타일에 사용하는 좋은 예는 Apache입니다. 개미 프로젝트.

누구나 좋아하는 오픈 소스 예제 프로젝트가 있습니다. 실제 세계, 작업 코드를 읽고 좋아하는 것을 선택하십시오. 그 프로젝트를 모방하십시오.

나는 그것을 위해 Google을 사용할 것입니다. 예를 들어 Java 코딩 가이드 라인을 검색하려면 사용하겠습니다. 이 쿼리 또는 스택 오버플로에 게시하고 Java에 권장되는 코딩 표준 지침이 무엇인지 묻습니다. 모든 언어에 대한 단일 소스를 가리키기가 어렵습니다.

회사/프로젝트를 위해 하나를 선택하고 그것을 고수하고 그것이 좋은 표준인지 확인하는 것이 좋습니다.

밥 삼촌을 읽는 것이 좋습니다 깨끗한 코드 코드 스타일 문제에 대해 걱정하는 경우

볼 수있는 좋은 곳이 세 가지 있습니다.

사용하는 언어에 대한 인기있는 책.
귀하의 언어로 작성된 오픈 소스 프로젝트.
귀하의 언어를위한 CheckStyle 유형 유틸리티.

CheckStyle 또는 PMD와 같은 도구를 사용하는 경우, 많은 "규칙"이 논란의 여지가있을 수 있습니다. 도움이 될 수 있습니다 문서를 확인하십시오 조심해야 할 규칙을 찾기 위해.

Microsoft에는 참조 문서가 있습니다 C#을 사용하지 않더라도 보는 데 유용 할 수있는 코딩 규칙을 사용합니다. 스타일과 기본 규칙을 넘어서, 여기에 다른 사람들이 추천하는 모범 사례 책 깨끗한 코드, 코드 기반의 향후 유지 관리자에게 적합한 유지 관리 가능하고 읽기 쉬운 코드를 작성하는 데 필수적인 읽기입니다.

Visual Studio (및 다른 현대 IDE)를 사용하는 경우 권장 규칙의 기본 불일치가 자동으로 밑줄이 표시됩니다 (최근 버전의 VS에서 호버에 대한 제안). VS에서 팀이 다른 표준을 사용하려면 프로젝트 속성을 열고 "코드 분석"(마지막 왼쪽 메뉴 항목)을 변경하십시오. 여기에 추가 : 규칙 세트를 사용하여 그룹 코드 분석 규칙을 사용합니다

모두에게 안녕하세요

글쎄, 나는 그것이 당신이 회사에서 일하는지 또는 당신을 위해 일하는지에 달려 있다고 말해야한다고 말해야합니다.)

회사에서 일하는 경우 Mus는 이름 지정 스타일 및 기타 규칙을 받아들입니다.

그리고 당신을 위해, 당신은 자신을 포함하여 모든 사람이 즉시 무엇을 어떻게, 어떻게 이해할 수있는 스타일을 확립하면됩니다.

괄호와 다른 사람들은 당신의 길입니다

그러나 당신이 말했듯이, 개별 언어가 있으므로 자체 규칙이 있습니다.

그리고 Mnementh가 말했듯이 모든 팀은 코딩에 대한 방법이 있습니다.

그게 전부가 더 이상 없다 .... 안녕히 해

거기에 있습니다 C 및 C ++ 스타일 가이드, Christopher Lott가 관리하는 USENET의 스타일 가이드, 코딩 규칙 및 토론의 짧은 페이지.

당신이 PHP 개발자이 두 가이드는 놓치지 않아야합니다.

라이센스 : CC-BY-SA ~와 함께 속성

제휴하지 않습니다 StackOverflow