docs(be): add admin/assignment, announcement jsdoc#3395
Open
docs(be): add admin/assignment, announcement jsdoc#3395
Conversation
…ignmentScoreSummary
…blemGraded, autoFinalizeScore
|
✅ Syncing Preview App Succeeded Application: |
RyuRaseul
reviewed
Feb 14, 2026
Comment on lines
+392
to
+405
| /** | ||
| * 과제에 문제들을 추가합니다. | ||
| * | ||
| * @param groupId 그룹 ID | ||
| * @param assignmentId 과제 ID | ||
| * @param assignmentProblemInput 추가할 문제 정보들 | ||
| * @returns 추가된 과제들 정보 | ||
| * @throws {EntityNotExistException} 아래와 같은 경우 발생합니다. | ||
| * - 요청한 과제가 존재하지 않을 때 | ||
| * @throws {ForbiddenAccessException} 아래와 같은 경우 발생합니다. | ||
| * - 요청한 그룹 ID와 과제에 해당하는 그룹 ID가 일치하지 않을 때 | ||
| * @throws {UnprocessableDataException} 아래와 같은 경우 발생합니다. | ||
| * - 트랜잭션 처리 중 오류가 발생할 때 | ||
| */ |
Contributor
There was a problem hiding this comment.
로직에 있는 몇몇 특이점들도 적어주면 좋을 것 같습니다
예를 들면, 이미 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 업데이트에 대한 주석이 따로 있으니 신경 안써도 될 듯 합니다
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
admin/assignment, admin/announcement에 jsdoc 추가
Additional context
Before submitting the PR, please make sure you do the following
fixes #123).