코드 분석 규칙
- 최종 업데이트2024/09/26
코드 분석 규칙
규칙은 코드 분석의 기초입니다. 규칙은 자동화(Task Bot 및 API 태스크) 로직을 평가하는 데 사용됩니다. 시행하는 평가에 따라 간단하거나 복잡한 규칙이 사용됩니다. 규칙에는 확인할 수 있는 코딩 관행이 포함됩니다. 자동화 코드의 패키지 및 작업에 적용됩니다.
규칙은 고유 RULE_CODE와 코드에 행할 평가의 특성을 나타내는 설명으로 구성됩니다. 심각도 수준(낮음 또는 높음)을 사용하여 규칙의 중요도를 강조할 수 있습니다.
다음 표에는 코드 분석에 사용할 수 있는 규칙과 그 설명이 나와 있습니다.
규칙 코드 | 그룹 | 제목 | 규칙 설명 | 자동화 파일에 적용 가능 |
---|---|---|---|---|
ACT-GEN-001 | 작업, 일반 | 최대 작업 | 봇의 작업 수는 지정된 최대값을 초과할 수 없음 | Task Bot, API 태스크 |
ACT-GEN-002 | 작업, 일반 | Try-Catch 범위 | 봇 로직 내 코멘트가 없는 모든 작업은 Try/Catch 블록 내에 있어야 합니다. | Task Bot, API 태스크 |
ACT-GEN-003 | 작업, 일반 | 무한 루프 감지 | 봇 로직에서 무한 루프 확인을 의무화합니다. | Task Bot, API 태스크 |
VAR-NMG-001 | 변수, 명명 | 변수 이름 패턴 | 변수 이름은 지정된 명명 패턴과 일치해야 함 | Task Bot, API 태스크 |
VAR-NMG-002 | 변수, 명명 | 변수 이름 길이 | 변수 이름은 지정된 최소 및 최대 문자 길이 사이여야 함 | Task Bot, API 태스크 |
VAR-USG-001 | 변수, 사용 | 미사용 변수 없음 | 모든 변수는 봇 내에서 사용해야 함 | Task Bot, API 태스크 |
VAR-USG-002 | 변수, 사용 | 입력 및 출력 변수의 수 제한 | 입력 및 출력 변수의 수는 지정된 최대값을 초과해서는 안 됩니다. | Task Bot, API 태스크 |
ACT-COM-001 | 작업, 코멘트 | 필수 헤더 코멘트 | 봇에서의 첫 번째 작업은 코멘트 작업이어야 함 | Task Bot, API 태스크 |
ACT-COM-002 | 작업, 코멘트 | 코멘트 범위 | 코멘트 작업의 수는 전체 명령 작업의 지정된 백분율 이상이어야 함 | Task Bot, API 태스크 |
VAL-HCV-002 | 값, 하드 코딩된 값 | 하드 코딩된 지연 없음 | 지연 작업의 지연 시간은 변수를 사용하여 설정해야 함 | Task Bot, API 태스크 |
VAL-HCV-003 | 값, 하드 코딩된 값 | 하드 코딩된 파일 경로 없음 | 파일 또는 폴더 경로는 변수를 사용하여 설정해야 함 | Task Bot |
VAL-HCV-004 | 값, 하드 코딩된 값 | 하드 코딩된 이메일 주소 없음 | 명령 작업 필드에는 하드 코딩된 이메일 주소가 없어야 함 | Task Bot, API 태스크 |
VAL-CRE-001 | 값, 하드 코딩된 값 | 안전하지 않은 문자열 사용 제한 | 안전하지 않은 문자열은 작업, 트리거 또는 변수에 사용하지 않아야 함 | Task Bot, API 태스크 |
ACT-ERR-001 | 작업, 오류 처리 | 빈 Catch 없음 | Catch 블록은 비워둘 수 없음 | Task Bot, API 태스크 |
ACT-ERR-002 | 작업, 오류 처리 | 필수 Catch 로깅 | Catch 블록에는 파일에 기록 작업이 포함되어야 함 | Task Bot, API 태스크 |
ACT-ERR-003 | 작업, 오류 처리 | 필수 Catch 화면 캡처 | Catch 블록에는 화면 캡처가 포함되어야 함작업 | Task Bot |
ACT-ERR-004 | 작업, 오류 처리 | 필수 Catch 라인 참조 | Catch 블록 오류에는 참조 라인 번호가 포함되어야 함 | Task Bot, API 태스크 |
ACT-LOG-001 | 작업, 로그 | 파일에 기록 범위 | 봇 로직은 파일에 기록 작업의 지정된 비율을 포함해야 함 | Task Bot |
VAL-LMT-001 | 값 제한 | 목록 값 최대 항목 제한 | 목록의 항목 수는 지정된 최대치를 초과하지 않아야 함 | Task Bot, API 태스크 |
VAL-LMT-002 | 값 제한 | 테이블 치수 제한 | 테이블의 크기는 지정된 최대값을 초과할 수 없음 | Task Bot, API 태스크 |
VAL-LMT-003 | 값 제한 | 기록 최대 항목 제한 | 기록의 항목 수는 지정된 최대치를 초과해서는 안 됩니다. | Task Bot, API 태스크 |
VAL-LMT-004 | 값 제한 | 사전 최대 항목 제한 | 사전의 항목 수는 지정된 최대치를 초과해서는 안 됩니다. | Task Bot, API 태스크 |
AIG-MDL-001 | AI 거버넌스 | 모델 사용 | 개발자가 사용할 수 있는 지역의 일부 모델에 대한 게시자 및 모델 또는 배포 ID를 제어할 수 있습니다. | Task Bot, API 태스크 |
AI 거버넌스에 대한 자세한 내용은 AI 거버넌스 코드 분석 규칙 항목을 참조하십시오. |