«comments» 태그된 질문

많은 사람들이 "의견은 '왜'를 설명해야하지만 '어떻게'를 설명해서는 안된다"고 주장합니다. 다른 사람들은 "코드는 자기 문서화되어야한다"고 말하고 주석은 드 물어야한다고 말한다. Robert C. Martin은 (내 말로 표현하면) "댓글은 잘못 작성된 코드에 대한 사과"라고 주장합니다. 내 질문은 다음과 같습니다 설명이 복잡한 복잡한 알고리즘이나 길고 복잡한 코드를 설명하는 데 무엇이 문제가 있습니까? 이 방법을 …

236 programming-practices  documentation  comments 

내 팀원 중 한 명이 자신의 코드에서 의견을 말하지 않습니다. 그의 코드는 자체 문서화가 아니며 다른 프로그래머는 자신의 코드를 이해하기가 어렵습니다. 나는 몇 번이나 그의 코드에 의견을 말하도록 요청했지만, 그는 나중에 할 것이라고 변명하거나 주장 할 뿐이다. 그의 우려는 의견을 추가하는 데 너무 많은 시간이 걸리고 프로젝트가 지연된다는 것입니다. 자신의 …

182 teamwork  team  comments 

나는 생명에 중요한 소프트웨어를 생산하는 상점에서 일했고 코드를 읽을 수있게하고 생명을 구할 수있는 주석 규칙을 처리했습니다. 내 경험상 요구 사항은 체크리스트에서 벗어나기 위해 두뇌를 잃은 일이되고 이해할 수있는 코드 작성에 집중하는 데 도움이되지 않습니다. 또한 동료 리뷰어가 코드를 이해하기 쉽게 만드는 방법에 대해 나와 의미있는 대화를 나누지 못하게합니다. 나는 또한 …

142 coding-standards  comments  standards  naming-standards  standardization 

내 동료를 믿고 어떤 에서 코드 주석의 사용 (즉,하지의 javadoc 스타일의 메소드 나 클래스 코멘트)을 인 코드 냄새 . 어떻게 생각해?

100 comments  anti-patterns 

주니어 개발자입니다. 저는 현재 회사의 큰 고객을 위해 웹 응용 프로그램에서 혼자 일하고 있습니다. 나는 지난 달에 시작했다. 고객은 각 소프트웨어 프로젝트에서 최소 25 %의 의견을 원합니다. 이전 응용 프로그램의 코드를 확인했으며 다음은 관찰 결과입니다. 각 파일은 주석 블록으로 시작합니다 (패키지, 마지막 업데이트 날짜, 회사 이름 및 저작권) 모든 변수는 …

96 project-management  comments  client-relations  hierarchy 

나는 상당히 큰 프로젝트를 진행 중이며 그것을 위해 일부 번역 작업을 수행했습니다. 번역되지 않은 많은 레이블이 있었고 코드를 파헤치는 동안이 작은 코드 조각을 발견했습니다. //TODO translations 이것은 대부분의 개발자가 특정 코드 조각을 얻은 후 개발자가 할 때까지 이것을 보지 않을 것이라는 느낌을 얻었 기 때문에 자신과 다른 사람들 에게이 의견의 …

86 documentation  comments 

의견에 관해 새로운 동료들과 토론을하고 있습니다. 우리는 Clean Code를 좋아 하고 인라인 코드 주석을 피하고 클래스와 메소드 이름을 사용하여 수행하는 것을 표현해야한다는 사실에 완벽하게 만족합니다. 그러나 저는 수업의 목적과 실제로 나타내는 것을 설명하는 작은 수업 요약을 추가하는 것을 좋아합니다. 주로 단일 책임 원칙 패턴 을 유지하기가 쉽습니다 . 또한 메소드가 …

83 comments  clean-code 

다음 코드를 작성했습니다. if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } 여기에 주석 처리 된 행이 있습니다. 그러나 if와 의 차이점을 분명히함으로써 코드를 명확하게 만든다고 생각합니다 else. …

83 documentation  comments 

우선,이 질문에서 나는 소스 코드 주석이 좋은지 나쁜지에 대한 논쟁에서 벗어나고 싶습니다. 나는 사람들이 왜, 무엇을 또는 ​​어떻게 말하는지를 언급 ​​할 때 사람들이 무엇을 의미하는지 더 명확하게 이해하려고 노력하고 있습니다. 우리는 종종 "의견은 왜 당신에게 말해야하는지, 코드 자체는 어떻게 당신에게 말해야하는지"와 같은 지침을 보게됩니다. 추상적 수준에서 진술에 동의하는 것은 쉽다. …

78 documentation  comments 

Subversion (우리가 직장에서 사용하는 것)은 커밋에 대한 의견을 요구하도록 구성 할 수 있지만 단순히 이것을 켜는 힘이 없습니다. 내가 알고 내 신속하게 커밋 뒤에 이유를 이해하는 것이 유용하기 때문에 내 커밋 주석 이유가있는 경우에만 메모리 조깅 등이다. 그러나 이것은 내가 항상 얻는 두 가지 반응에 맞서기에 충분하지 않은 것 같습니다. …

78 version-control  comments 

나는 상사에 의해 가르치고 있습니다 (방금 학교를 마치고 약간의 프로그래밍 경험을 가진 사람을 원했기 때문에 회사가 전문화하는 것을 훈련하도록 선택했습니다). ASP.NET MVC 응용 프로그램, 일부 HTML 및 CSS 작업을 시작했습니다 . 나는 그가 나에게주는 웹 디자인 물건으로 괜찮습니다 (명백하지 않고 이해하는 것은 매우 간단합니다). 그러나 예를 들어, 그는 ASP.NET MVC와 …

72 comments 

XXX의견에서 볼 때마다 사람들은 일반적으로 무엇을 의미합니까 ? 때로는 다음과 같은 주석이 표시됩니다. # XXX - This widget really should frobulate the whatsit 물론, 의견의 의미를 알 수 있지만 XXX의 의미는 무엇입니까? "이것은 핵이다"또는 "아마도 나중에 다시 방문해야 할까"라고 말하는가? 아니면 완전히 다른 말을하고 있습니까?

71 comments  coding-standards 

방금 작성한 일부 (archaic Visual Basic 6.0) 코드에서 다음 주석을 작성하는 것을 발견했습니다. If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if 내가 왜 내 의견에 "우리"를 무의식적으로 사용하는지 잘 모르겠습니다. 누군가가 코드를 실제로 실행하는 것을 보는 것이 아니라 실제로 각 …

63 comments  coding-standards 

배경 다운 타임 제로 배포를 구현하려는 팀에서 일하고 있습니다. 이를 달성하기 위해 블루 / 그린 배포 전략을 사용할 계획입니다. 제가 연구를 수행하면서 실현하고있는 것 중 하나는 데이터베이스를 변경하기가 얼마나 복잡하다는 것입니다. 열 이름을 바꾸는 것과 같은 간단한 작업은 완료 될 때까지 3 번의 전체 릴리스주기를 수행 할 수 있습니다 ! …

51 continuous-integration  deployment  comments  continuous-delivery 

누군가 한 번은 모든 메소드 앞에 /// <summary>주석 블록 (C #)을 붙여야한다고 말했지만 그 이유는 설명하지 않았습니다. 나는 그것들을 사용하기 시작했고 그들이 나를 약간 짜증나게 했으므로 라이브러리와 정적 메소드를 제외하고는 사용을 중단했다. 그들은 부피가 크며 항상 업데이트하는 것을 잊고 있습니다. /// <summary>코드에 주석 블록 을 사용해야 할 이유가 있습니까? 나는 …

49 c#  comments