그누보드 문서화 작업중입니다. > 자유게시판

자유게시판

그누보드 문서화 작업중입니다. 정보

그누보드 문서화 작업중입니다.

본문

안녕하세요.

그누보드 문서화를 시도하고 있습니다.
아마 많은 분들은 이미 머리속에 그누보드 디비나 변수,함수 등이 익숙하실테지만,
저같이 막 배우기 시작한 사람들에게는 좀 도움이 되지 않을까 해서요.. ^^

byfun님의 나린위키로 문서화를 시작했습니다.
가능한 자동화 하고 싶은데, 사실 소스코드나 디비에 주석이 (거의)없는 관계로 반자동으로 하고 있습니다. ^^;
(혹시 php 소스를 역공학으로 분석할 수 있는 툴이나 프로그램 아시는 분 추천좀.. )

1. 소스코드 (진행중)예: common.php => 링크

일단 목표는, 각 php 코드에서 다른 php를 include 하거나 링크로 사용하는 경우, 서로 링크로 연결하도록 하고,
그누보드의 고유 함수와 전역변수 는 별도의 해당 페이지로
그리고 php 함수는 php.net 매뉴얼 페이지로 연결하도록 하려고 합니다.
아직 빠진 링크와, 포함화일/함수/변수 뽑아내는 부분은 부분미완성입니다.

2. DB테이블 (완료) : 목록 페이지, 예: member_table

이미 많은 분들이 DB테이블 관련 정리를 올리셨는데, 최신 버전에서 몇가지 변한 부분도 있고,
앞으로 완료될 소스코드나, 다른 문서화 정보와 연결하면 더 좋을 것 같아서 시도했습니다.

3. 함수 및 변수 (준비중)

함수는, 일부 함수 정의 위에 있는 한줄 주석과 함수의 소스코드내 위치 정도를 뽑아서 제공하려고 합니다.
그밖에 함수의 기능이나 사용법 등은, 수작업이 필요하고요.

변수 (예 $4) 가 가장 고민인데, 일부 변수들은 사용되는 위치에 따라서 들어있는 내용이 달라지는 경우도 있고 해서 어떻게 해야 할지 고민입니다.

일단 시작은 수작업으로 했는데, (예 $4) 얼마나 도움이 될지, 어떤 정보가 들어가면 좋을지 조언을 부탁드립니다.


(지난번의 그누보드4 다운로드 보다는 좀 의미가 있지 않을까 하는데, 그래도 의미가 있는 짓인지 계속 회의가..-_-)
추천
0

댓글 9개

오 대단합니다. 전에 저도 해보려다가 '그냥 Git.hub 쓸까' 하려다 말았었는데 ㅋㅋㅋ
그누위키 좋네요^^!
변경사항 생기면 그때마다 기록되는 점도 좋습니다^^!
아무도 관심을 안주셔서 삐뚤어지려던 참이었는데.. 역시 엔피씨님 ^^ 감사!

Git.hub이나 구글코드 등 코드저장소에서 코드 prettify 해주는 것은 가능한데,
제가 있었으면 했던 기능이, 그누의 함수나 디비, 변수 등 하고 연동하는 것여서요..^^ 그리고 가끔 php 함수 헷갈릴때도 있고 해서. .^^;

phpdoc 같은 툴을 쓰려면 docblock인가 하는 것으로 주석을 달아야 하는데,
그럼 새 버전 나오면 반영하기도 힘들고 해서..
그냥 아는 함수 등록해서 파싱하는 방식으로 했어요.. ^^

아마 여기 자주 오시는 분들에게는 큰 도움은 안될테고,
그누보드 초보분들이나 나름 스킨 고쳐서 써보려는 분들에게 도움이 되었으면 하는 바람이 있네요. .^^
그누초보가 보기쉽게 인터페이스구조만 조금 더 변경하면 되지않을까 생각합니다^^!
나머지 부분은 꼼꼼하게 연동하셨네요!
전체 199,647 |RSS
자유게시판 내용 검색

회원로그인

(주)에스아이알소프트 / 대표:홍석명 / (06211) 서울특별시 강남구 역삼동 707-34 한신인터밸리24 서관 1402호 / E-Mail: admin@sir.kr
사업자등록번호: 217-81-36347 / 통신판매업신고번호:2014-서울강남-02098호 / 개인정보보호책임자:김민섭(minsup@sir.kr)
© SIRSOFT