내 방법에 추가 빠른 문서 설명 (android studio)

Question

메서드 빠른 설명서의 설명에 추가 할 수있는 방법이 있습니까? 내가 만든 몇 가지 메소드가 있는데, 나중에이 라인에서 사용하기로하고 빠른 문서에 추가하여 메소드를 직접 잊어 버렸을 때 어떻게 생각 하는지를 생각 나게한다. 메서드가 않습니다.

Answer 1

방법 빠른 설명서의 설명에 추가 할 수있는 방법이 있습니까?

메서드를 문서화하는 가장 좋은 방법은 해당 매개 변수와 매개 변수에 의미있는 이름을 지정하는 것입니다.

주석은 코드가 표현하는 내용을 반복해서 설명하지 말아야합니다. 그러나 발전기는 거기에서 당신의 의도를 추출하기 위해 머리를 들여다 보지 않습니다. 코드를 분석하고 이미 작성된 내용을 기반으로 설명을 작성합니다.
따라서 (의미있는) 주석은 생성 할 수 없습니다.

당신이 (자신을) 코멘트를 작성해야하는 이유 두 가지 타당한 이유가 있습니다

1. 인터페이스

   는

   인터페이스는 발신자를 표현하는 방법 뒤에 계약을 설명하기 위해 (의 JavaDoc) 의견이 필요합니다 구현 자의 도움으로 기대. 비정상적인 방법으로 수행 코드에서 뭔가

2. 홀수 볼 솔루션

   있습니까? 다음에 덧글을 추가하십시오 왜 그렇게 했습니까.

법적 사안 등의 의견이있을 수 있습니다. 저작권 표시, 라이센스 텍스트 등을 포함합니다. 그러나 다른 의견이 있으면 안됩니다. 특히 아무것도 생성하지 마십시오.

Answer 2

전체 프로젝트의 한 곳에서 주석을 달거나 주석 집합을 파일 집합과 함께 배치하려면 README를 사용하십시오. 이들은 일반적으로 쉽게 읽을 수 있도록 아름답게 형식화 된 HTML로 쉽게 변환 할 수 있도록 Markdown에 작성됩니다. online markdown editor을 사용해보십시오.