«comments» 태그된 질문

버그 수정 / CR 구현의 일부로 코드가 변경 될 때마다 시작 태그, 종료 태그, 설명, 솔루션 등으로 주석을 추가하라는 요청을 받았습니다. 내 관심사는 이것이 부가 가치를 제공합니까? 현재 버전 관리 기록에 모든 세부 정보가 있습니다. 각 변경 사항을 추적하는 데 도움이됩니까? 그러나 제 리드는 "좋은"프로그래밍 실습으로 의견을 주장하고 있습니다. 그들의 …

42 version-control  bug  comments  change 

헤더 주석 안에 파일 자체에 버그 번호를 넣는 것이 좋은 방법입니까? 주석은 다음과 같습니다. MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error description 도움이 될 것 같지만 나쁜 습관으로 간주됩니까?

40 version-control  development-process  source-code  comments 

나는 사람들이 "의견이 구식이되는 경향이있다"고 주장하는 것을 끊임없이 본다. 문제는 내 경력 전체에 2 ~ 3 개의 오래된 의견이있는 것 같습니다. 별도의 문서에있는 오래된 정보는 항상 발생하지만 내 경험상 코드 자체의 오래된 주석은 매우 드 exceed니다. 내가 함께 일하는 사람이 방금 운이 좋았습니까? 특정 산업이 다른 산업보다이 문제에 더 취약합니까? …

38 comments  myth 

프로그래밍 과정 동안 코드를 설명하는 주석과 코드를 제거하는 주석이 생깁니다. // A concise description const a = Boolean(obj); //b = false; 어느 것을 빨리 파싱하는 좋은 방법이 있습니까? 나는 3을 사용 /하고 /** */설명적인 의견을 가지고 놀았습니다 . 또한 VSCode 플러그인을 사용하여 강조 표시 //TODO:하고//FIXME:

36 javascript  comments 

주석이 적용되는 줄에 맞지 않는다고 가정하면 코드 앞이나 뒤에 주석을 작성해야합니까? 글을 읽는 사람이라면 어디에서나 주석의 범위를 가장 잘 이해할 것입니다. 다시 말해서, 대부분의 프로그래머 / 스크립트 작성자가 그러한 의견을 제시 할 때마다. 따라서 대부분의 프로그래머 / 스크립터는 코드 앞이나 뒤에 주석을 넣는 위치는 무엇입니까? 답변이 특정 언어에만 적용되는 경우, …

34 comments 

주석은 일반적으로 프로그래밍 언어 및 마크 업에서 어떻게 처리됩니까? 일부 사용자 정의 마크 업 언어에 대한 파서를 작성하고 있으며 가장 놀랄만 한 원칙 을 따르고 싶습니다 . 따라서 일반적인 규칙을 결정하려고합니다. 예를 들어, 토큰에 포함 된 주석이 토큰과 '간섭'해야합니까? 일반적으로 다음과 같습니다. Sys/* comment */tem.out.println() 유효한? 또한 언어가 줄 바꿈에 …

31 parsing  comments 

신진 개발자를 겨냥한 코드 주석 작성에 대한 명확한 안내서가 있습니까? 이상적으로는 주석을 사용해야 할 때와 사용하지 않아야 할 시점 및 어떤 주석을 포함해야하는지 설명합니다. 이 답변 : 현재하고있는 일에 대해서는 언급하지 말고 왜해야합니까? WHAT는 변수 이름을 적절히 선택하여 깔끔하고 읽기 쉽고 간단한 코드로 처리합니다. 주석은 코드 자체로는 보여줄 수없는 (또는 …

27 language-agnostic  comments 

폐쇄되었습니다 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 오년 전에 . SO Tavern 에서이 질문을 보았 으므로 여기에 질문을 게시하고 있습니다. 나는 그것이 흥미로운 질문이라고 생각했다. (물론 SO에 속하지는 …

27 source-code  comments  coding-style  grammar 

이 질문은 Software Engineering Stack Exchange에서 답변을 얻을 수 있기 때문에 Stack Overflow에서 마이그레이션 되었습니다. 8 년 전에 이주했습니다 . 코드에서 주석을 작성하는 것에 대한 조언과 경험을 듣고 싶습니다. 가장 쉽고 유익한 방법으로 작성하는 방법은 무엇입니까? 코드의 일부를 주석 처리 할 때 어떤 습관이 있습니까? 이국적인 추천일까요? 이 질문이 모든 …

26 coding-style  comments 

폐쇄되었습니다 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 방금 함수형 프로그래밍을 시작하고 코드에 주석을 달 수있는 올바른 방법이 궁금합니다. 이름과 서명이 이미 알아야 할 모든 …

25 functional-programming  comments 

주석을 중첩 할 수없는 언어는 한 언어로만 나타나지 않습니다. 이 문제에 대한 좋은 해결책이 있습니까? C / C ++ 및 Java의 한 가지 해결 방법은 한 줄 주석 만 사용하는 것이지만 더 큰 블록을 주석 처리하는 것은 불가능합니다. 나는 이런 식으로 직면하고있다 : </li><!-- <li><!-- Save --> 따라서 수동으로 주석을 …

23 java  c++  python  c  comments 

잠김 . 주제를 벗어난 의견이 많았 기 때문에이 질문은 잠겨 있습니다. 현재 새로운 답변이나 상호 작용을받지 않습니다. 검색을했지만 찾고있는 것을 찾지 못했습니다.이 질문이 이미 요청 된 경우 언제든지 연결해주세요. 이달 초이 게시물이 작성되었습니다. http://net.tutsplus.com/tutorials/php/why-youre-a-bad-php-programmer/ 기본적으로 요약하면 의견을 쓰지 않으면 나쁜 프로그래머입니다. 내 개인적인 의견은 코드가 설명 적이어야하며 코드가 자체 설명 …

22 coding-standards  comments 

코드가 잘못되었거나 다른 이유로 인해 필요한 주요 아키텍처 변경 사항에 맞게 조정되어야하므로 코드의 많은 부분을 변경해야 할 때마다 이것이 일반적으로 수행하는 작업입니다. 변경해야 할 것으로 의심되는 모든 코드를 주석 처리합니다. 주석 처리 된 코드를 일종의 TODO 목록으로 취급합니다. 주석 처리 된 코드를 검토 하고이 코드의 주석 처리를 제거하거나 다른 곳에서 …

21 anti-patterns  comments 

이 질문은 Software Engineering Stack Exchange에서 응답 할 수 있기 때문에 Stack Overflow에서 마이그레이션 되었습니다. 7 년 전에 이주했습니다 . 요즘 댓글 달기가 훨씬 쉬워졌습니다. Java에는 주석을 클래스에 연결하는 멋진 기술이 있으며 Java IDE는 주석 쉘을 만드는 데 능숙합니다. Clojure와 같은 언어를 사용하면 함수 코드 자체에 함수 설명을 인수로 추가 …

20 java  python  clojure  comments 

일부 오픈 소스 프로젝트에서 다음 코딩 스타일을 수집했습니다. void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } 나는 항상 false여기 에 무슨 의미 가 있는지 의심 합니다. "forget"을 의미합니까, "forget"은 해당 매개 변수 (위의 경우와 같이)를 나타내며 "false"는이를 무시하는 것입니까? 어떤 스타일이 가장 자주 사용되며 모호성을 피하는 가장 …

19 coding-style  comments  boolean