이 질문에 이미 답변이 있습니다. :
댓글
답변
다음을 문서화해야합니다.
및
- 안될 수있는 사항 어떻게이 부분을 최적화 했는가?
이 부분을 최적화 한 이유, 바로 가기가 정확히 무엇인지, 예상 한 결과가 무엇인지, 요구 사항이 무엇인지, 그 이유가 무엇인지 우선,이 데이터는 어디로 전송됩니까, 어디에서 입력을 얻습니까, 멀티 스레드 인 경우 모델을 설명하고, 데이터베이스가있는 경우 스키마, 링크, 이유를 설명합니다 …
명백한 내용을 문서화하지 마십시오. 프레젠테이션에 관해서는 여러 가지 방법이 있습니다. 개인적으로 인라인 주석을 좋아합니다 (저는 예전 프로그래머 였고 당시에는 멋진 도구가 없었습니다. 간단하고 간단합니다.) 멋진 것을 원한다면 시간을 너무 많이 소비하지 않도록하십시오. 그렇지 않으면 곧 포기할 가능성이 큽니다.
댓글
Answer
2 년 이상 전에 작성한 코드를 읽어보세요.
어떤 유형이 불분명한지 스스로에게 물어보고 머리를 긁적입니다. 이러한 유형의 것 (어떤 것이 든 프로그래머마다 다를 수 있음)은 개발 한 새 코드 또는 다시 작성 / 재사용하는 이전 코드에 대해 먼저 문서화를 시작하려는 것입니다. 이해를 늦추는 형식 , 변경.
또는 2 년 후 …
답변
한 가지 include는 종속성입니다. 함수가 저기 의 무언가에 의존한다면 doc 그것이 무엇인지, 저기 가 어디에 있는지, 그리고 그 이유를 언급하십시오.
답변
PHP를 사용하고 있으므로 PHPDoc 시작하는 것이 좋습니다. 소스에서 API 문서를 인라인으로 빌드 한 다음 동일한 형식을 사용하여 자습서 및 사용자 문서를 작성할 수 있습니다. 또한 출력 형식에 대한 유연성도 얻을 수 있습니다.
답변
저는 항상 주석을 먼저 작성하여 코드 작성을 시작합니다. 프로그램의 흐름을 설명하면 주석을 달아야하는 것과 그렇지 않은 것을 깨닫기 시작할 것입니다. 코드 작성을 시작한 후에는 추가 설명이 필요한 부분을 꾸미고 자체 문서화되는 부분을 수정합니다.
각 클래스, 함수 또는 메서드가 완료되면 돌아가서 주석을 추가합니다. doxygen 또는 PHPDoc과 같은 문서 생성기의 경우 실제 API 문서를 얻을 수 있습니다.
누가 내 코드를 사용하는지에 따라 LaTeX 또는 Word로 운영 문서에 대한 공식적인 설명을 작성합니다.
p>
답변
Doxygen은 대부분의 언어를 다룹니다. 구문을 이해하는 데 시간을 투자해야하지만 가장 큰 문제는 무엇을 문서화해야하는지입니다. 각 함수를 블랙 박스로 취급합니다. 들어오고 나가는 것을 문서화합니다. 트랩하는 오류, 인수가 null 일 수 있는지 여부를 문서화합니다. null을 반환 할 수 있는지 여부.
단 몇 달 안에 함수가하는 일을 파악할 수 없다는 점을 기억하십시오. 시간을 절약하는 것뿐입니다.