나는 적당한 수술을 위해 일하는 최근 AI 졸업생입니다 (2 년경). 기본적으로 (유용한 부분입니까?) C # 코딩 표준 문서를 작성하는 것이 나에게 떨어졌습니다.
필자는 아마도 가장 후배의 소프트웨어 엔지니어 일 것이라고 설명해야한다고 생각하지만 실제로이 절반 정도 사용할 수있는 제품을 생산할 수 있기를 기대하고 있습니다. 인터넷을 광범위하게 검색하고 코딩 표준 문서에 포함하거나 포함하지 않아야 할 내용에 대한 기사를 읽었습니다. 이것은 어떤 제안을 요구하는 곳만큼 좋은 것 같습니다.
나는 ‘일을하는 가장 좋은 방법’에 대한 전 세계의 의견 불일치에 대한 문을 열었 음을 알고 있습니다. 나는 각 프로그래머가 각 개별 과제를 해결하는 선호하는 방법을 가지고 있다는 부인할 수없는 사실을 이해하고 존중합니다. 결과적으로 개인의 감각을 억압하기 위해 엄청나게 서술적인 것을 쓰지 않고 일반적인 방법론을 시도하고 동의하려고합니다. 개인 코드를 더 읽기 쉽게 만드는 표준 (예 : 명명 규칙).
그래서 여기에 간다 …. 어떤 제안? 전혀 없습니까?
답변
우리는 시작합니다
- Microsoft의 .NET 지침 : http://msdn.microsoft.com/en-us/library/ms229042.aspx(.NET 4.5 용 링크 업데이트)
- 마이크로 소프트의 C #을 지침 : http://blogs.msdn.com/brada/articles/361363.aspx .
그런 다음 해당 기준과의 차이점과 추가 사항을 문서화하십시오.
답변
IDesign 에는 일반적으로 사용되는 C # 코딩 표준 문서가 있습니다. 프레임 워크 디자인 가이드 라인 2nd Ed 도 참조하십시오 .
답변
아이러니하게 실제 표준을 설정하는 것이 쉬운 부분 일 수 있습니다.
저의 첫 제안은 다른 엔지니어들로부터 그들이 다루어야 할 느낌과 그들이 중요하다고 생각하는 지침에 대한 제안을 이끌어내는 것입니다. 모든 종류의 지침을 시행하려면 어느 정도의 사람들의 바이 인이 필요합니다. 코드를 작성하는 방법을 지정하는 문서를 갑자기 내려 놓으면 가장 중학교이든 수석이든 상관없이 저항에 부딪치게됩니다.
제안서가 준비되면 팀으로 보내 피드백과 검토를 받으십시오. 다시 말하지만 사람들이 모두 구매하도록 유도하십시오.
이미 채택 된 비공식적 인 코딩 관행이있을 수 있습니다 (예 : 접두사 멤버 변수, 낙타 함수 이름). 이것이 존재하고 대부분의 코드가 그것을 준수하면 사용을 공식화하는 비용을 지불합니다. 반대 표준을 채택하면 일반적으로 권장되는 경우에도 가치보다 슬픔을 유발할 수 있습니다.
새로운 코딩 표준을 충족시키기 위해 기존 코드를 리팩토링하는 것도 고려할 가치가 있습니다. 시간 낭비처럼 보일 수 있지만 표준에 맞지 않는 코드를 사용하면 다른 스타일의 혼란이 생길 수 있으므로 역효과를 낳을 수 있습니다. 또한 특정 모듈의 코드가 새로운 표준을 준수해야하는지 또는 기존 코드 스타일을 따라야하는지 딜레마에 빠지게합니다.
답변
나는 코딩 표준 / 모범 사례를 내부적으로 수행 할 때 항상 Juval Lowy의 pdf 를 참조로 사용했습니다. 이 표준은 FxCop / Source Analysis 와 매우 유사 하며 표준을 준수하는지 확인하는 또 다른 소중한 도구입니다. 이러한 도구와 참조 간에는 모든 개발자가 따르지 않고 적용 할 수있는 훌륭한 표준을 제시 할 수 있어야합니다.
답변
다른 포스터는 기준선에서 당신을 가리 켰습니다. 추가해야 할 것은 문서를 짧고 달콤하고 요점에 맞추는 것입니다. “.
표준 문서를 코딩하는 데있어서의 문제점은 아무도 자신이 원하는대로 읽지 않으며, 읽을 때 따르지 않는다는 것입니다. 그러한 문서가 읽히고 따를 가능성은 길이에 반비례합니다.
FxCop이 좋은 도구이지만이 중 너무 많으면 프로그래밍에서 모든 재미를 얻을 수 있으므로주의하십시오.
답변
자신 만의 코딩 표준을 작성하지 마십시오. MS 표준 (또는 Sun 표준 또는 언어에 따라)을 사용하십시오. 단서는 표준이라는 단어에 있습니다. 각 조직이 자체적으로 작성하기로 결정하지 않으면 세상은 훨씬 쉽게 코딩 할 수 있습니다. 팀 / 프로젝트 / 역할을 변경할 때마다 새로운 ‘표준’을 배우는 것은 누구의 시간이든 잘 활용하는 사람입니다. 당신이해야 할 가장 중요한 것은 요점을 요약하는 것입니다. 그러나 중요한 것은 사람마다 다르기 때문에 그렇게하지 않는 것이 좋습니다. 코딩 표준에 대해 말하고 싶은 두 가지 다른 점
- 닫기는 충분합니다-코드에 따라 코딩 표준을 따르도록 코드를 변경하는 것은 코드가 충분히 가까운 한 시간 낭비입니다.
- 코드를 변경하는 경우 ‘로컬 코딩 표준’을 따르지 않고 새 코드를 주변 코드처럼 보이게합니다.
이 두 가지 점은 모두가 똑같이 보이는 코드를 작성하기를 희망하는 현실입니다.
