Skip to content

docs(be): add admin/assignment, announcement jsdoc#3395

Open
westsunh wants to merge 20 commits intomainfrom
t2443-add-jsdocs-annonce-assign-service
Open

docs(be): add admin/assignment, announcement jsdoc#3395
westsunh wants to merge 20 commits intomainfrom
t2443-add-jsdocs-annonce-assign-service

Conversation

@westsunh
Copy link

@westsunh westsunh commented Feb 1, 2026

Description

admin/assignment, admin/announcement에 jsdoc 추가

Additional context


Before submitting the PR, please make sure you do the following

@westsunh westsunh requested review from RyuRaseul and hjkim24 February 1, 2026 16:23
@westsunh westsunh self-assigned this Feb 1, 2026
@westsunh westsunh changed the title docs(be): add admin/assignment, admin/announcement jsdoc docs(be): add admin/assignment, announcement jsdoc Feb 1, 2026
@skkuding-bot
Copy link

skkuding-bot bot commented Feb 2, 2026

Syncing Preview App Succeeded

Application: frontend
Revision: 9b6d99946f0e30b492526b023a9d187a390f4b12
Health Status: Healthy

Open Preview | View in Argo CD

Comment on lines +392 to +405
/**
* 과제에 문제들을 추가합니다.
*
* @param groupId 그룹 ID
* @param assignmentId 과제 ID
* @param assignmentProblemInput 추가할 문제 정보들
* @returns 추가된 과제들 정보
* @throws {EntityNotExistException} 아래와 같은 경우 발생합니다.
* - 요청한 과제가 존재하지 않을 때
* @throws {ForbiddenAccessException} 아래와 같은 경우 발생합니다.
* - 요청한 그룹 ID와 과제에 해당하는 그룹 ID가 일치하지 않을 때
* @throws {UnprocessableDataException} 아래와 같은 경우 발생합니다.
* - 트랜잭션 처리 중 오류가 발생할 때
*/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

로직에 있는 몇몇 특이점들도 적어주면 좋을 것 같습니다
예를 들면, 이미 Import된 문제는 건너뛰는 것이나, visibleLockTime을 새로 설정 하는 등의 동작들도 있으니까요

Suggested change
/**
* 과제에 문제들을 추가합니다.
*
* @param groupId 그룹 ID
* @param assignmentId 과제 ID
* @param assignmentProblemInput 추가할 문제 정보들
* @returns 추가된 과제들 정보
* @throws {EntityNotExistException} 아래와 같은 경우 발생합니다.
* - 요청한 과제가 존재하지 않을
* @throws {ForbiddenAccessException} 아래와 같은 경우 발생합니다.
* - 요청한 그룹 ID와 과제에 해당하는 그룹 ID가 일치하지 않을
* @throws {UnprocessableDataException} 아래와 같은 경우 발생합니다.
* - 트랜잭션 처리 오류가 발생할
*/
/**
* 과제에 문제들을 추가합니다.
* @description
* 1. 과제와 그룹의 유효성을 검증합니다.
* 2. 이미 추가된 문제는 건너뛰고 새로운 문제만 트랜잭션으로 처리합니다.
* 3. 문제 추가 , 해당 문제의 '공개 제한 시간(visibleLockTime)' 과제 종료 시간으로 업데이트하고 그룹에 공유합니다.
* 4. 기존 과제 참여자들에 대해 해당 문제의 기록(AssignmentProblemRecord) 생성합니다.
* @param groupId 그룹 ID
* @param assignmentId 과제 ID
* @param assignmentProblemInput 추가할 문제 정보들
* @returns 추가된 과제들 정보
* @throws {EntityNotExistException} 아래와 같은 경우 발생합니다.
* - 요청한 과제가 존재하지 않을
* @throws {ForbiddenAccessException} 아래와 같은 경우 발생합니다.
* - 요청한 그룹 ID와 과제에 해당하는 그룹 ID가 일치하지 않을
* @throws {UnprocessableDataException} 아래와 같은 경우 발생합니다.
* - 트랜잭션 처리 오류가 발생할
*/

제미나이에 따르면 위처럼 적어주면 좋다고 하네요 @description 어노테이션을 쓰면 좋을 듯 합니다
이 API를 제외한 부분에는 visibleLockTime 업데이트에 대한 주석이 따로 있으니 신경 안써도 될 듯 합니다

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants