«comments» 태그된 질문

C #에서 XML 주석에 대한 모범 사례 권장 사항을 찾고 있습니다. 속성을 만들 때 예상되는 XML 설명서의 형식은 다음과 같습니다. /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. /// </summary> public int ID { get; set; } 속성의 서명이 이미 알려줍니다하지만 이후 …

19 c#  .net  programming-practices  comments 

jQuery 코드의 주석에서 많은 문제 번호를 보았습니다 . (실제로 jQuery 코드에는 69 개의 ​​이슈 번호가 있습니다.) 좋은 습관이라고 생각하지만 지침을 본 적이 없습니다. 좋은 방법이라면이 방법에 대한 지침은 무엇입니까?

18 comments  issue-tracking 

내가 아는 한 인기있는 것은 아니지만 몇 가지 있습니다. 주석을 중첩시키는 데 나쁜 점이 있습니까? 나는 작업중 인 (작은) 언어로 블록 주석을 중첩 할 계획이지만 이것이 나쁜 생각인지 알고 싶습니다.

18 language-agnostic  syntax  comments 

휴무 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 나는 종종 그러한 주석이 사용되는 것을 보았습니다. function foo() { ... } // foo while (...) { …

18 source-code  comments 

우리 상점의 선임 개발자는 코드가 수정 될 때마다 책임이있는 프로그래머가 자신이 한 일을 나타내는 인라인 주석을 추가해야한다고 주장합니다. 이 의견은 보통 다음과 같습니다// YYYY-MM-DD <User ID> Added this IF block per bug 1234. 우리는 개정 관리에 TFS를 사용하며, 이런 종류의 주석은 인라인 노이즈가 아닌 체크인 메모로 훨씬 더 적합한 것으로 …

17 coding-standards  comments 

우리 팀의 개발자 중 하나는 메소드의 서명에 모든 매개 변수에 대한 javadoc 주석을 작성해야한다고 생각합니다. 나는 이것이 필요하다고 생각하지 않으며 실제로는 그것이 해로울 수도 있다고 생각합니다. 먼저 매개 변수 이름은 설명적이고 자체 문서화되어야한다고 생각합니다. 매개 변수가 무엇인지 즉시 분명하지 않으면 아마도 잘못하고있을 것입니다. 그러나 매개 변수가 무엇인지 명확하지 않은 경우가 …

17 java  documentation  source-code  comments  maintainability 

일부 코드베이스에서는 다음과 같은 내용의 주석을 볼 수 있습니다. // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) 몇 가지 질문이 있지만 모두 관련이 있습니다. 프로그램의 의견에 SO 질문에 대한 링크를 넣는 것이 괜찮습니까? // We're now mapping from the "sorted-on column" to original indices. // // There's …

16 comments 

NotImplementedException아직 작성하지 않은 코드 를 던지는 것은 나쁜 습관으로 간주 됩니까? TODO 의견이 더 안전한 것으로 간주 될 수 있습니까?

15 .net  comments  coding  exceptions 

여기에 무엇이 요청되는지 말하기가 어렵습니다. 이 질문은 모호하거나 모호하거나 불완전하거나 지나치게 광범위하거나 수사적이며 현재 형태로 합리적으로 대답 할 수 없습니다. 다시 열 수 있도록이 질문을 명확하게 설명 하려면 도움말 센터를 방문하십시오 . 휴일 팔년 전에 . 호기심으로, 주석을 허용하지 않는 언어가 자체 주석 코드를 작성해야 할 때보 다 읽기 쉬운 …

15 comments 

현재로서는이 질문이 Q & A 형식에 적합하지 않습니다. 답변, 사실, 참고 자료 또는 전문 지식을 통해 답변이 뒷받침 될 것으로 예상되지만이 질문은 토론, 논쟁, 여론 조사 또는 광범위한 토론을 요구할 것입니다. 이 질문을 개선하고 다시 열 수 있다고 생각 되면 도움말 센터 를 방문하여 안내를 받으십시오 . 휴일 칠년 전에 …

15 comments 

엔티티, 비즈니스 로직 및 데이터 액세스 클래스에 대한 유익한 클래스 문서 형식을 찾고 있습니다. 여기 에서 두 가지 형식을 발견 했습니다. 형식 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: …

15 c#  documentation  comments 

충돌 마커를 고려하십시오. 즉 : <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD 이 질문을 게시하도록 동기를 부여한 특별한 경우에, 책임이있는 팀 구성원은 방금 업스트림에서 지점으로 병합을 완료했으며, 어떤 경우에는 방금 이전에 대한 일종의 문서로 주석으로 남겨 두었습니다. 해결되었습니다. 그는 그것을 컴파일 된 상태로두고 테스트를 통과 했으므로 …

14 version-control  comments  coding-style 

계산 기하학과 그래픽 및 이러한 종류의 주제를 다루는 많은 (주로 c ++ 및 javascript) 코드를 작성하므로 시각적 다이어그램이 문제 해결 과정에서 없어서는 안될 부분이라는 것을 알았습니다. 나는 "오, 손으로 그린 ​​다이어그램을 어떤 방식으로 코드에 주석으로 첨부 할 수 있다면 환상적 이지 않을 것"이라고 지금 막 결정 했다. 며칠, 몇 주, …

14 productivity  code-reviews  comments  workflows  image-manipulation 

우리는 20 년 된 레거시 코드베이스로 리팩토링을하고 있으며 코드의 주석 형식 (plsql, java)에 대해 동료와 토론하고 있습니다. 주석의 기본 형식은 없지만 대부분의 경우 주석에서 다음과 같은 작업을 수행합니다. // date (year, year-month, yyyy-mm-dd, dd/mm/yyyy), (author id, author name, author nickname) and comment 내가 원하는 미래 및 과거 의견에 대한 제안 …

13 java  c#  programming-practices  code-quality  comments 

기술적으로 불필요한 추가 로컬 변수를 사용하여 발생하는 상황을 설명하는 것이 좋은 스타일입니까? 예를 들면 다음과 같습니다. bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } 기술 오버 헤드에 관해서는 컴파일러 가이 추가 라인을 최적화 할 것으로 기대합니다. 그러나 불필요한 코드 팽창으로 간주됩니까? 내 눈에 그것은 …

12 coding-style  comments