Visual Stio Code에서 Restructure Text를 쓸 때 TODO Tree

메시지
일자
기사 쓰는 날.
2020-09-24
기사 수정 날짜
----------
이 같은 내용은 이 글의 신선도를 판단하는 데 도움을 주기 위해 GitHub - yabuki/friendly-potato: zenn-contents 상세한 변경 이력을 참고하시기 바랍니다.
보도된 티포의 지적 등에 대해 풀리q를 할 수 있다면 기쁠 것 같다.수용 여부는 차분과 풀 레q의 글로 판단한다.

개시하다

Visual Studio Code(이하 vscode)와 파생된 VSSCodium[1]을 사용하여 Sphinx[2] 문서인 RestructuredText[3]를 처리하는 사람을 위한 글입니다.
태그의 Restructuredtext는 태그가 끊어져서 뽑혔습니다.

토도 트리란?

프로그램과 파일을 만들 때

TODO

FIXME

등 댓글을 달고 코드와 파일의 손이 돌아가지 않았지만 반드시 해야 할 일은 표 등을 이전 단계에 끼워 넣은 대상의 원본 코드와 디자인 파일로 작업 스타일을 추진하는 사람들에게 매우 편리한 확장이다.

Todo Tree - Visual Studio Marketplace

각 파일에는 이러한 태그가 표시됩니다.링크를 보면 이해하기 쉽다.

문제점

두 개 있어요.

때때로 자신이 사용하고 있는 라벨이 없음

유감스럽게도 Todo Tree의 기본 상태에서는 restructure text의 주석 형식이 지원되지 않으므로 문서에 쓰지 않으면 Todo Tree가 감지되지 않습니다.

그래서

Todo Tree 를 restructued text 에 대응

Tag 추가

사용자 설정 -> 설정을 통해 설정 화면을 열고 확장 기능에서 Todo Treea를 선택하여 다음 화면을 표시합니다.

여기에 적힌 해시태그가 아니면 팀이 공유하면 작업 공간을 통해 개인은 설정에 직접 적는다.
예를 들어, NOTE Tag이 부족하다고 생각하는 사람도 있습니다.단, sphinx의 기법에서 주석을 나타낸다

.. note::

Upper Lower를 자세히 관리할 수 있는 사람이 아니면 Restructure text, sphinx
이럴 땐 조심하는 게 좋을 것 같은데.
Restructured text 리뷰의 조건은 모두가 좋아하기 때문에 확인하는 것이 좋습니다
간단히 말하면.(dot) 두 개의 평론.
마찬가지로 축소도 중요하다.

댓글도 태그를 알게 한다.

Regex: Regex
Regular expression for matching TODOs. Note: $TAGS will be replaced by the tag list.
위의 섹션은 원래 다음과 같습니다.

((//|#|<!--|;|/\*|^)\s*($TAGS)|^\s*- \[ \])

.. 한번 보세요.다음과 같은 내용을 추가했다및사이에 정규 표현식을 추가합니다.
Escape 없이 썼는데, 돌이 정규 표현이라는 걸 떠올리며 기사를 썼으니 정말 다행이다.
그리고 사용자 설정과 작업 공간 설정은 작업 공간 설정이 비교적 강하다는 점도 주의해야 한다.

((//|#|<!--|\.\.|;|/\*|^)\s*($TAGS)|^\s*- \[ \])

각주
VSCodium/vscodium: binary releases of VS Code without MS branding/telemetry/licensing ↩︎
개요 - Sphinx 4.0.0+/e2079865c 설명서 ↩︎
reStructuredText - Wikipedia ↩︎