소스 문서에 "부활절 달걀"을 추가하는 것이 전문가가 아닌지 묻고 싶습니다. 아마 당신이 읽게 에 StackOverflow의 소스 문서에 재미 덧글에 대한 설문 조사를하고, 나는 개인적으로 (예를 들어, 공개 API 문서에이 약한 물건을 재미를 포함하여, 내 작품 중 많은 그런 것들에서 발견 (여부) 한 BZZZTT을! 1! 일 안드로이드 공개 문서에서는 적어도 12 가지 이상의 예제를 제공 할 수 있습니다.
나는 스스로 논쟁의 여지가 있기 때문에 나 자신에 대한 최종 의견을 얻을 수 없다.
찬성론 :
- 누군가를 응원하고 하루를 더 재미 있고 생산적으로 만들 수 있습니다. 소스 코드의 주요 부분은 어쨌든 (프로젝트가 올바르게 수행 된 경우) 주석 처리 할 필요가 없습니다. 특정 방법 (예 :)이 자체 설명이거나 이상한 크 래핑 코드 더미 인 경우에는 할 수 없습니다 재미있는 농담은 의사가 얻을 수있는 정보에 해를 끼치 지 않습니다.
단점 :
- 매우 집중적이거나 좌절 한 경우, 마지막으로 필요한 것은 누군가의 어리석은 농담이며 문서화 된 코드 부분에 대해 필요한 정보를 제공하는 대신 더욱 좌절하게 만들 수 있습니다. 모든 사람이 그렇게하기 시작하면 문서가 어떻게 보일지에 대한 아이디어는 끔찍합니다. 또한 농담을 쓰는 사람은 재미 있거나 흥미롭고 / 읽는 시간을 낭비한다고 생각하는 유일한 사람 일 수 있습니다.
어떻게 생각해?