# Documentation
[Foundation] URLSession
[Foundation] URLSession NSURLSession 네트워크 데이터 전송 작업과 관련된 그룹을 조정하는 객체 Declaration Overview NSURLSession 클래스 및 관련 클래스는 URL로 표시된 endpoint에서 데이터를 다운로드하고 업로드하기 위한 API를 제공합니다. 앱이 실행 중이 아닐 때나 iOS에서 앱이 일시 중단된 동안 백그라운드 다운로드를 수행하기 위해 이 API를 사용할 수도 있습니다. NSURLSessionDelegate 및 [NSURLSessionTaskDelegate](https://develope
JSDoc 사용해서 문서화하기 (feat. Github Pages 배포)
이미지 출처: https://www.reddit.com/r/programming/comments/nllcvt/typecheckyourjavascriptwithjsdoc/ JSDoc > JavaScript의 API를 문서화하는 툴이다. JSDoc에서 제공하는 태그를 이용해서 클래스, 함수, 모듈, 메서드, 파라미터 등을 문서화한다. 여러 종류의 태그들이 있어서 잘 사용하면 구체적인 정보가 담긴 문서를 만들 수 있다. JSDoc의 태그 종류 jsdoc.app JSDoc 3.6 한국어 📌 JSDoc 사용 방법 주석을 코드와 함께 소스코드에 작성하면, JSDoc이 소스코드를 기반으로 HTML 문서를 생성한다. 주석을 작성할 때 /* 주석 / 와 같이 입력하면 JSDoc이 인식할 수 있는 주석이 된
221104~1106_광고 관리 플랫폼 대행사 센터 제작 48_대시보드 기능 기획 & 대시보드 기능 구현 - 대행사 대시보드 1
해당 게시글은 개인 프로젝트인 "광고 관리 플랫폼 대행사 센터 제작" 중 #133 "대시보드 기능 기획", #135 "대시보드 기능 구현 - 대행사 대시보드" 이슈를 다루고 있습니다. 1. 진행 사항 (1) 요약 대시보드 기능 기획 대시보드 기능 구현 chart.js 테스트 대시보드 페이지 구현 대행사 대시보드 대시보드 통계 기능 구현 전체 일일 소진액 (2) 상세 내용 (2-1) 대시보드 기능 기획 대행사 대시보드 전체 일일 소진액 (일 단위, 월 단위) 예시 : 10/01 ~ 10/29 시 1~29일의 일일 전체 소진액 차트화 (일 단위) 예시 : 1월, 2월, 3월... 전체 소진액 차트화 (월 단위) 상위 탑 10 광고주 소진액 (기간 합계) 예시 : 10/01 ~ 10/29 일 간 광고주 별 총 소진액 중 탑 1
221028_광고 관리 플랫폼 대행사 센터 제작 43_1.3.0 버전 릴리즈 기획
해당 게시글은 개인 프로젝트인 "광고 관리 플랫폼 대행사 센터 제작" 중 #125 "GitHub 1.3.0 version 릴리즈 기획" 이슈를 다루고 있습니다. 1. 1.3.0 버전 릴리즈 추가/개선 목표 정리 (1) 통계 조회 기능 수정 통계 조회 기간 표시 광고 관리의 광고주 전체 소진액 통계를 제외하고는 통계 조회 기간이 따로 노출되어 있지 않고 있음. 빠르게 수정 필요. (2) 임의 기간 조회/통계 제공 기능 추가 임의 기간 조회 / 통계 제공 기능 추가 현재 최근 7일간, 30일간의 통계를 조회하는 기능만 구현되어 있음 사용자가 원하는 임의의 기간 통계를 제공할 수 있도록 기능을 추가 단, 기간 선택 시 캘린더 제공 기능은 혼자서 하기도 힘들고 품이 많이 들어갈 것 같아 수동으로 입력하시는 식으로 대체 -> 추후 개선 (3) 보고서 파일 다운로드 기능 추가 **보고서 파일 다
221019_광고 관리 플랫폼 대행사 센터 제작 34_1.2.0 버전 릴리즈 기획
해당 게시글은 개인 프로젝트인 "광고 관리 플랫폼 대행사 센터 제작" 중 #102 "GitHub 1.2.0 version 릴리즈 기획" 이슈를 다루고 있습니다. 1. 1.2.0 버전 릴리즈 추가/개선 목표 정리 (1) 도메인 수정 연관관계 매핑 수정 현재 모든 엔티티가 다대일-일대다 양방향으로 연관관계 매핑이 되어 있는데 이것이 적절한 지 검토 후 수정할 예정 (굳이 양방향으로 처리하지 않아도 되는 건이 있는지) 지연 로딩 수정 일대다로 연결된 엔티티가 현재 지연 로딩이 세팅이 되어 있지 않아 수정 필요, 생성되는 SQL 쿼리 양 확인 기타 수정 필요한 사항 고려 / 수정 JPA 강의 수강하면서 도입하거나 수정이 필요한 부분이 있는지 체크하여 개선 통계 관련 쿼리 테스트를 진행하면서 추가로 수정해야 할 부분이 있는지 체크, 수정 (2) 통계 관련 쿼리 테스트 ** 실제 SQL 작성
220913_광고 관리 플랫폼 대행사 센터 제작 17_1.1.0 버전 릴리즈 기획
해당 게시글은 개인 프로젝트인 "광고 관리 플랫폼 대행사 센터 제작" 중 #56 "GitHub 1.1.0 version 릴리즈 기획" 이슈를 다루고 있습니다. 1. 1.1.0 버전 릴리즈 추가/개선 목표 정리 (1) 리팩토링 DTO 및 Response 수정 현재는 Agent (에이전트 단독) / AgentWithClients (에이전트-담당 광고주 매핑) 등으로 DTO 및 Response가 분리되어 있으나 통일시켜도 무방하다고 판단됨 따라서 위와 같은 구조로 설계된 에이전트 그룹, 에이전트, 광고주, 캠페인, 소재에 대해 수정 진행 들여쓰기 수정 회사에서 IDE가 아닌 notepad++로 코딩을 하고 집에서 붙여넣는 경우가 있었는데 이 때 들여쓰기 관련 오류가 발생하는 것을 확인. 1.0.0 버전 릴리즈 이전에 수정을 하긴 하였으나 한 번 더 점검 예정 HTML 쪽 들여쓰기도 엉망인
220810~0813_광고 관리 플랫폼 대행사 센터 제작 4_API 설계, DB 접근 로직 테스트
해당 게시글은 개인 프로젝트인 "광고 관리 플랫폼 대행사 센터 제작" 중 #9 "API 설계", #11 "DB 접근 로직 테스트 정의 및 로직 구현" 이슈를 다루고 있습니다. 1. DB 연결 세팅 및 접근 로직 테스트 (1) DB 연결 세팅 MySQL Driver를 통해 MySQL DB 연결 application.yml에 DB 접근 계정에 대한 정보가 노출되어 있어 이 부분에 대한 처리가 추후 필요할 듯 (2) DB 접근 로직 테스트 및 결과 (~/11) 각 엔티티에 대한 Repository 생성 및 JpaRepository 상속 (그 외의 상속은 아직 미지정) 테스트를 위한 data.sql 작성 CRUD 테스트를 진행하였으나 INSERT 부분에서 오류가 발생 중. 
220809_광고 관리 플랫폼 대행사 센터 제작 3_도메인 설계
해당 게시글은 개인 프로젝트인 "광고 관리 플랫폼 대행사 센터 제작" 중 #6 "도메인 설계" 이슈를 다루고 있습니다. 1. 도메인 ERD 작성 (1) 작성 관련 draw.io를 사용하여 작성하였음 유스케이스 작성 사례와 마찬가지로 main에 바로 커밋하였기 때문에 feature로 커밋하지는 못했다 흑흑 (2) 작성 결과 크게 에이전시, 에이전트 그룹, 에이전트, 광고주, 캠페인, 소재로 구분하여 작성하였음 에이전트는 그룹을 따로 지정해주지 않아도 됨 광고주는 반드시 에이전트가 지정되어야 하며 구상 초기와 다르게 에이전시 -> 광고주 직접 매핑은 불가하게끔 변경 에이전트 그룹 - 에이전트와 에이전트 - 광고주는 optional 캠페인 및 소재의 경우 광고 성과와 관련된 소진액 / CTR / CVR / ROAS 등은 SQL을 통해 별도로 계산할 예정 소재 스타일은 11번가의 포커스 클릭과 유사하게 진행하였으나 노출
220808_광고 관리 플랫폼 대행사 센터 제작 2_플랫폼 Use Case Diagram 작성
해당 게시글은 개인 프로젝트인 "광고 관리 플랫폼 대행사 센터 제작" 중 #3 "플랫폼 유스케이스 작성" 이슈를 다루고 있습니다. 1. Use Case Diagram 작성 (1) 작성 관련 draw.io를 통해 작성하였으며, GitHub과 연동하였음 다만 참고 강의에서 진행하였던 GitKraken Terminal로 파일을 먼저 생성하여 이슈를 남기고 그 이슈 내부에서 추가로 draw.io와 연계하여 작업을 하고 커밋을 하던 부분은 하지 않았음 (회사에서 시간 내면서 하는 터라 GitKraken을 깔 수가 없다... ㅠㅠ) (2) 작성 결과 공통적인 기능은 User를 통해 작성하였으며 이 User는 대행사 어드민 계정인 Agency Master와 일반 에이전트 계정인 Agent로 구분됨 대행사 어드민 전용 기능을 따로 작성하였음 
220808_광고 관리 플랫폼 대행사 센터 제작 1_목표 구체화 및 요구사항
해당 게시글은 개인 프로젝트인 "광고 관리 플랫폼 대행사 센터 제작" 중 #2 "프로젝트 기획" 이슈를 다루고 있습니다. 1. 목표 구체화 (1) 문제 파악 광고 대행사의 매체 커뮤니케이션 및 영업지원을 담당하는 채널 부서의 경우 광고 매출 트렌드 파악 및 정리를 위해 광고 관리 플랫폼을 항상 사용하는데 이 과정에서 겪고 있는 문제점을 기술함 (1-1) 에이전트 그룹-에이전트-광고주 매칭 기능 부재 일부 광고 매체를 제외하고 플랫폼 상에서 광고주에 대한 정보는 있으나 정작 에이전트, 에이전트 그룹에 대한 정보가 누락되어 있거나 리포트 출력 시 제외되는 경우가 많음 에이전트-광고주가 매핑된 매체는 그래도 어느 정도 있긴 하지만 에이전트 그룹-에이전트
Kaleidoscope: Introduction & Lexer
Reference 1. The Kaleidoscope Language 2. The Lexer
[Kotlin] KDoc으로 코틀린 코드 문서화하기 (feat. Dokka)
시작 이직을 하거나 프로젝트에 합류할때면 문서화의 중요함을 매번 느낍니다. 여러 개발자가 함께 개발하는만큼 서로가 바로 이해하지 못하는 코드들을 언어로서 풀어서 쉽게 파악할 수 있게 도움을 줍니다. 가장 흔하게 접할 수 있는 문서로는 API 문서가 있습니다. 본 글에서는 KDoc, Dokka를 통해 안드로이드 코드에 문서를 작성하는 방법에 대해 다룰 예정입니다. KDoc KDoc은 Kotlin 코드의 문서화를 위한 언어이고 JavaDoc과 동일하다고 볼 수 있습니다. JavaDoc의 여러 문법들과 흡사하지만 큰 차이점은 JavaDoc은 HTML을 사용하고 KDoc은 마크다운을 사용합니다. 문법 > JavaDoc과 동일하게 KDoc은 로 시작하여 로 끝납니다. 통상적으로 문서의 첫번째 단락은 요약이고 두번째 단락부터는 자세한 설명입니다. 모든 블록태그는 줄의 앞부분에 위치하고 로 시작합니다. 다음은 KDoc의 예시 코드입니다. 블록태그 | Blo
XCode Documentation
XCode 내부에서 type 또는 function 위에 마우스를 올려놓은 채로 Option-Clicking 을 하면 상세 설명이 나오는데, 아래와 같이 직접 주석을 통해 내가 만든 함수를 문서화 할 수 있다.
JsDoc - 소스 코드 comment 기재 방법(documentation)
JSDoc이란? > Javasript 소스코드 파일에 주석을 달기위해 사용되는 마크업언어 출처: https://okayoon.tistory.com/entry/JSDoc를-사용해서-Javasript-문서화해보자 [Zzolab Blog :)]
[Dart] Effective Dart - Documentation
Effective Dart - Style > 간결하고 정확한 주석은 시간절약에 도움이 됩니다. 하지만 모든 주석이 도움이 되는 것은 아니고, 코드 자체만으로도 충분하도록 코드를 작성하는게 좋습니다. Comments DO format comments like sentences. DON’T use block comments for documentation. Doc comments DO use /// doc comments to document members and types. > Linter rule: slashfordoccomments_ PREFER writing doc comments for public APIs. > Linter rule: packageapidocs, publicmemberapidocs_ CONSIDER writing a library-level doc c
공식문서 읽기의 어려움
유데미 튜토리얼이 후반에 접어들면서 Advanced Level의 Flask를 배우는 중이다. 고급 레벨은 하나 하나 떠먹여 주던 초,중급과는 다르게 Requirement만 주고 프로젝트를 클론하게 한다. 그래도 공식문서 정도는 첨부해주는데 문제는 공식문서를 이해하지 못하겠다는 것이다. 강사인 Angela는 초심자가 겪는 문제인 "Tutorial Hell"강의만 따라하다가 코딩실력이 늘지 않음)"에서 구원하기 위해 이런 구성을 했다고 한다. 도저히 공식 문서만 봐서는 이해하고 코드를 칠 수가 없어서 튜토리얼을 따라가기위해 다른 튜토리얼을 구글해보기에 이르렀다. 오픈북 시험인데 문제를 못풀겠는 무력감이 밀려온 지난 몇 주간이었다. * 공식문서 읽기에 어려움을 겪는 주니어들이 많다는 것을 알게된 것이 그나마 위안이 됐다.* 지난 주말 블로그를 통해 알게된 여성 개발자 모임 줌에 참여했다. 주니어 레벨의 모임이라 공부법, 힘든 점 등 많은 이야기를 나눴는데 그 중 다수
8. def Title (//): return #
1. substr_count() ex) 문장에 해당 단어가 몇개 있는지 표시하는 함수 2. strrev() ex) 문장을 거꾸로 표시하는 함수 3. strtolower() strtoupper() ex 해당 부분을 소문자로 4. str_repeat() 해당 부분을 반복해서 표시 Number Functions 1. 2. 3. echo rand(1, 52); 은 1과 52사이에 숫자중 하나를 랜덤으로 뽑는다. 4. Documentation strpad ( string $input , int $padlength [, string $padstring = " " [, int $padtype = STRPADRIGHT ]] ) : string 5. Ceil 올림 6.
NESTJS로 Swagger 문서화 하기
오늘은 nestjs로 Swagger API 문서 만들었던 작업을 정리하려고 한다. 지금껏 nodejs express를 이용해 여러 API들을 만들면서 항상 골칫거리였던 것이 API 문서화였다. nestjs가 나오기 전 Express API를 문서화 하는 방법에는 여러가지가 있었는데 내가 선택했던 방법은 주석을 파싱해서 Swagger 문서를 만드는 방법이었다. 기존 방법 이 방법은 Swagger 문서를 만드는 swagger-jsdoc 및 swagger-ui-express가 코드 내 모든 @swagger 데코레이터가 달린 주석들을 파싱해 API문서들을 만들어 준다. Definition 일단 굉장히 번거롭고 좋지 않다고 생각하기 때문에 자세히 언급하지는 않겠지만 대충 다음과 같이 사용했다. ![definition예시](https://images.velog.io/images/chunghwanyoon/post/e69f428c-3f8d-48b6-8f10-5e29f2