자료를 공개한다면 이렇게... 정보
자료를 공개한다면 이렇게...
본문
-. 이왕 공개할 것이라면 소스코드의 주석 및 자질구레한 주석문을 깔끔하게 제거한 후 공개해 주었으면...
-. 딱 딱 줄 맞추고 질문자가 원하는 '맞춤형 자료'로 공개를...
-. 주석문 필요없이 줄 맞추고 정리를 칼처럼 깔끔하게 해 줬으면...
여러분은 어떠한 자료를 원하십니까?
단순히 깔끔한 스타일만 필요한 경우도 있고,
경우에 따라서는 '구구절절' 세세한 설명이 필요한 자료도 있고,
'이것 저것 귀찮은 경우라면' '맞춤형 자료'를 기대하는 경우도 많고...
그렇다 할지라도 단 하나만 '콕 찝어' 보신다면 어떨까요?!
주석문은 타인이 이해하는데 있어 상당한 도움을 주지만,
세세한 주석문은 '밑천 드러내기'의 시작이 됩니다.
추천
0
0
댓글 11개
무슨 무슨 로그를 들여다 보다 머시기를 보게 되었는데...
그런데... '바다 웹호스팅'이라고 곳도 있나요?
그런데... '바다 웹호스팅'이라고 곳도 있나요?
주석정리는 필요에 따라서 있으면 좋을수도 있구요.
줄 맞추는 작업은 반드시 하셔야 합니다.
줄이 안맞으면 볼필요없이 통과~~~~
줄이 맞으면 안볼려고 해도 소스의 기본 맥락을 보게되는 ... 직업병 발작~~~
줄 맞추는 작업은 반드시 하셔야 합니다.
줄이 안맞으면 볼필요없이 통과~~~~
줄이 맞으면 안볼려고 해도 소스의 기본 맥락을 보게되는 ... 직업병 발작~~~
root님 소스코드는 대부분 한 눈에 들어 옵니다.
(이해가 되는 것은 별개의 문제이지요~*^^*)
(이해가 되는 것은 별개의 문제이지요~*^^*)
잘 정리된 주석은 도움이 되긴하더군요.
근데 어떤건 눈이 아플정도로 어지러워서...ㅠ.ㅠ
근데 어떤건 눈이 아플정도로 어지러워서...ㅠ.ㅠ
소스코드의 줄맞춤은 기본이지만(테스트 하는 입장에서 어긋나 있으면 소스코드가 보이질 않습니다.),
정신없이 아이디어를 정리해서 간단히 테스트만 마치고 작성하는 경우를 제외하고는,
스스로가 차후에라도 들여다보거나 해당 자료를 이용하게 될 사용자들을 위해,
대부분 세세하게 주석을 남기는 편에 속합니다만(경우에 따라서는 주석을 완전히 배제하고 싶기도 합니다만...),
자료 공개시 '첨부된 소스파일의 주석문 참조'라고 기재하는 것은,
특별하게 쓸 말이 없어서 그냥 '영양가 없는 타이핑'을 하는 것이 아니라는 것을
누누히 강조함에도 불구하고 동일한 질문과 질문과,
자료의 공개자가 우려하는 바가 재차 언급되기 때문입니다.
상당한 경우는 해당 '주석문을 일일이 기재해야 할 필요성이 있을까?'라는
의구심이 상당히 빈번하게 일어나기도 합니다.
그래서 가끔은 실제 의미가 있는 서너줄 정도의 소스코드도 직접 '긁어붙이기'가 가능한 형태(텍스트)가 아니라,
한번 더 읽어 보고 직접 찾아보라는 의미로 이미지화 시켜 등록시키기도 합니다.
(직접 찾아보는 것 만큼 큰 공부는 없으니까요.)
정신없이 아이디어를 정리해서 간단히 테스트만 마치고 작성하는 경우를 제외하고는,
스스로가 차후에라도 들여다보거나 해당 자료를 이용하게 될 사용자들을 위해,
대부분 세세하게 주석을 남기는 편에 속합니다만(경우에 따라서는 주석을 완전히 배제하고 싶기도 합니다만...),
자료 공개시 '첨부된 소스파일의 주석문 참조'라고 기재하는 것은,
특별하게 쓸 말이 없어서 그냥 '영양가 없는 타이핑'을 하는 것이 아니라는 것을
누누히 강조함에도 불구하고 동일한 질문과 질문과,
자료의 공개자가 우려하는 바가 재차 언급되기 때문입니다.
상당한 경우는 해당 '주석문을 일일이 기재해야 할 필요성이 있을까?'라는
의구심이 상당히 빈번하게 일어나기도 합니다.
그래서 가끔은 실제 의미가 있는 서너줄 정도의 소스코드도 직접 '긁어붙이기'가 가능한 형태(텍스트)가 아니라,
한번 더 읽어 보고 직접 찾아보라는 의미로 이미지화 시켜 등록시키기도 합니다.
(직접 찾아보는 것 만큼 큰 공부는 없으니까요.)
주석이라...
본인이 소스 만들때 주석 안붙이죠 ...
마찬 가지입니다.
본인이 소스 만들때 주석 안붙이죠 ...
마찬 가지입니다.
나중엔 만들어 놓은 내용이 대체 무슨 내용인지 스스로도 헷갈리는 경우가 있기 때문에,
만드는 사람마다 다르겠지만 본인이 만들게 되더라도 주석문은 필요한 경우가 있습니다.
경우에 따라서는 반대적인 상황도 생각해 볼 수 있습니다.
공개내용은 줄 잘 맞춘 소스코드만 기재하고,
공개자가 참조용으로 사용할 내용은 주석문까지 보존하는 형태로...
만드는 사람마다 다르겠지만 본인이 만들게 되더라도 주석문은 필요한 경우가 있습니다.
경우에 따라서는 반대적인 상황도 생각해 볼 수 있습니다.
공개내용은 줄 잘 맞춘 소스코드만 기재하고,
공개자가 참조용으로 사용할 내용은 주석문까지 보존하는 형태로...
공개자체의 의의를 둡니다만..
요즘은 예제나 스크린샷에 더 눈이 간다는
결국 결과물이 탐이나야.. 대충 작성되어 있던지 뒤죽박죽이던지 보게된다는...
-_-;;
주석은 개인적으로 제일 상단에 사용법과 몇가지 중요변수 정리 수준이면.. 만족하긴 합니다만
이건 제가 주로 클래스쪽을 보다보니 생긴 습관이라서.. php쪽으로는 조금 상황이 다를지도
요즘은 예제나 스크린샷에 더 눈이 간다는
결국 결과물이 탐이나야.. 대충 작성되어 있던지 뒤죽박죽이던지 보게된다는...
-_-;;
주석은 개인적으로 제일 상단에 사용법과 몇가지 중요변수 정리 수준이면.. 만족하긴 합니다만
이건 제가 주로 클래스쪽을 보다보니 생긴 습관이라서.. php쪽으로는 조금 상황이 다를지도
네. 말씀하신 형태는 가장 일반적인 경우라 생각되며,
한 눈에 상당부분이 파악되는 형태이기도 합니다.
한 눈에 상당부분이 파악되는 형태이기도 합니다.
주석은 있으면 좋고, 없어도 그만~~
줄만 잘 맞춰도 소스가 이뻐 보입니다....^^
줄만 잘 맞춰도 소스가 이뻐 보입니다....^^
저는 공개할 자료에 한해서는 세세한 주석문을 남기는편입니다.
그누보드에 공개되어있는 소스들은 그것을 인클루드해서 리턴값을 사용하는게 많을거라 생각합니다.
물론 사용자 입장에서는 애코찍어 나오는 결과물만 필요할지를 모르나,
질문게시판에보면 함수의 속성값만 변경해서 사용해도 되는데도 '이거 어떻게 하나요?'라며 질문글을 남기시더군요.. 그래서 저는 공개할때 코드를 보고 재사용성을 높일수 있도록 주석문을 상세하게 적는편입니다^^
그누보드에 공개되어있는 소스들은 그것을 인클루드해서 리턴값을 사용하는게 많을거라 생각합니다.
물론 사용자 입장에서는 애코찍어 나오는 결과물만 필요할지를 모르나,
질문게시판에보면 함수의 속성값만 변경해서 사용해도 되는데도 '이거 어떻게 하나요?'라며 질문글을 남기시더군요.. 그래서 저는 공개할때 코드를 보고 재사용성을 높일수 있도록 주석문을 상세하게 적는편입니다^^