«comments» 태그된 질문

폐쇄되었습니다 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 버전 관리 의견의 경우 과거 또는 현재 시제로 다른 사용자가 수행 / 권장하는 것은 무엇입니까? 즉 x를 …

12 comments  source-code 

나는 지금 약 10 년 동안 진화 한 꽤 큰 개인 코드베이스를 가지고 있습니다. 나는 phpDocumentor를 사용하지 않지만 오픈 소스 프로젝트에서 docblock 섹션을 사용하는 것이 표준이되었으므로 저장소의 모든 공용 메소드에 docblock을 작성하는 것을 채택했습니다. 대부분의 블록에는 모든 매개 변수와 반환 유형에 대한 작은 설명과 타입 힌트가 포함되어 있습니다. 정적 분석이 …

12 php  comments 

저는 "스파게티 코드"프로젝트를 진행 중이며 버그를 수정하고 새로운 기능을 구현하는 동안 코드를 단위로 테스트 할 수 있도록 리팩토링도합니다. 코드는 종종 너무 밀접하게 결합되거나 복잡하여 작은 버그를 수정하면 많은 클래스가 다시 작성됩니다. 그래서 리팩토링을 중단하는 코드 어딘가에 선을 그리기로 결정했습니다. 이를 명확히하기 위해 상황에 대해 설명하는 코드에 다음과 같은 주석을 추가합니다. …

11 refactoring  comments 

정규 표현식에 주석을 달기위한 일반적인 관행이 있습니까? 인라인 주석은 RegEx의 다른 부분을 참조하거나 모든 표현식에 대한 일반적인 주석입니까?

11 documentation  coding-style  comments 

나는 오늘 동료와 이야기하고 있었다. 우리는 두 가지 다른 프로젝트를 위해 코드 작업을합니다. 제 경우에는 본인의 코드를 작성하는 유일한 사람입니다. 그녀의 경우, 여러 사람이 동일한 코드베이스에서 일하며, 정기적으로 (8-12 개월마다) 정기적으로 오가는 협동 학생을 포함합니다. 그녀는 자신의 의견에 자유로 워서 모든 곳에서 의견을 전했습니다. 그녀의 추론은 코드의 많은 부분이 그녀가 …

11 coding-style  team  comments 

Java에서 더 이상 사용되지 않는 클래스를 식별하기 위해 주석을 추가하는 가장 좋은 방법을 알고 싶습니다. 다른 프로그래머가 해당 클래스가 무엇인지 알 수 있도록 클래스 상단에 추가 된 이전 주석을 제거해야합니까, 아니면 주석 아래에 추가해야합니까?

11 java  code-quality  api  comments 

작은 스크립트를 직접 작성할 때 코드를 주석으로 묶습니다 (때로는 코드보다 주석을 추가합니다). 많은 사람들이 개인적으로도이 스크립트를 문서화해야한다고 말하면서 팔아서 팔면 준비가되었습니다. 그러나 주석은 문서 ​​형태가 아닌가? 그렇지 않습니까? $foo = "bar"; # this is a comment print $foo; # this prints "bar" 특히 개발자가 내 코드를 사용하는 경우 문서로 간주됩니까? …

11 documentation  comments 

나는 문서에 XML 주석을 요구하는 팬이었습니다. 그 이후로 두 가지 주요 이유로 마음이 바뀌 었습니다. 좋은 코드와 마찬가지로 메서드는 설명이 필요합니다. 실제로, 대부분의 XML 주석은 추가 가치를 제공하지 않는 쓸모없는 잡음입니다. 여러 번 우리는 단순히 GhostDoc을 사용하여 일반적인 주석을 생성합니다. 이것이 쓸모없는 소음이라는 의미입니다. /// <summary> /// Gets or sets …

10 .net  programming-practices  development-process  documentation  comments 

나는 올바르게 문서화 된 코드를지지하는 사람이며 가능한 단점을 잘 알고 있습니다 . 그것은이 질문의 범위를 벗어납니다. Visual Studio에서 IntelliSense를 얼마나 좋아하는지 고려하여 모든 공개 멤버에 대해 XML 주석 을 추가하는 규칙을 따르고 싶습니다. 그러나 중복성에는 한 가지 형태가 있는데, 나와 같은 과도한 논평자도 귀찮게합니다. 예를 들어 List.Exists ()를 사용하십시오 . …

10 documentation  comments  intellisense 

equals, compareTo 등과 같이 널리 알려진 방법에 대한 주석을 작성하는 것이 좋은 방법입니까? 아래 코드를 고려하십시오. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for equals } 우리 회사는 위와 같은 의견을 입력해야합니다. …

10 java  comments 

Robert C. Martin의 Clean Code 를 읽고 있는데이 코드TILT 는 일부 코드 샘플에 설명 할 수 없습니다. 예를 들어 (Java로되어 있음) : ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; case ErrorCode.MISSING_ARGUMENT: return "Missing …

9 java  clean-code  comments  conventions 

나는 프로젝트를 떠나려고하고 있고, 가기 전에 상사가 코드를 문서화하도록 요청했다 (문서화가 잘되지 않았다). 큰 문제는 아닙니다. 프로젝트는 그리 복잡하지 않습니다. 그러나 나는 문서에서 "XYZ 라인에 그러한 일이 발생한다는 알림"을 ​​말하고 싶은 곳을 찾고있다. 이 경우 한 줄의 코드를 추가하거나 삭제하면 즉시 문서보다 오래 걸리기 때문에 특정 줄 번호를 참조하는 것은 …

9 documentation  comments 

DRY 방식으로 Javadoc을 작성하고 싶습니다. 그러나 Javadoc 에 대한 오라클 문서 는 과부하 방법 주석에서 동일한 것을 다시 작성한다고 말합니다. 반복을 피할 수 없습니까?

9 documentation  comments  dry  javadocs 

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

9 comments 

이것은 어리석은 질문 일지 모르지만 잠시 동안 내 머리 속에 있었고 다른 곳에서는 괜찮은 대답을 찾을 수 없습니다. 선생님이 있는데 각 매개 변수가 설명이있는 경우에도 설명과 함께 명시 적으로 나열해야한다고 말합니다. 이것은 많은 반복으로 이어집니다. double MyFunction(const int MyParam); // Function: MyFunction // Summary: Does stuff with MyParam. // Input: …

9 documentation  comments  coding-style