| Version | GIF Preview | Description |
|---|---|---|
| Block |  |
The Block version generates tsDOC comments in a block format above the selected type. It helps to understand the code structure at a glance, aiding in comprehension. |
| Inline |  |
The Inline version adds tsDOC comments directly above each property or method. It provides detailed information, deepening the understanding of individual elements. |
tsDoc Generator is a Visual Studio Code extension that automatically generates tsDOC comments for TypeScript interfaces and types. By simply dragging over the type and pressing cmd+e on macOS or ctrl+e on Windows and Linux, users can effortlessly generate comprehensive documentation, saving time and enhancing code readability. This extension is perfect for projects of any size, ensuring consistent and maintainable documentation.
- Easy Documentation: Generate tsDOC comments with a simple keyboard shortcut.
- Supports Multiple Platforms: Works on macOS, Windows, and Linux.
- Improves Readability: Enhances code readability by providing detailed documentation.
- Saves Time: Automates the documentation process, saving developers' time.
- Consistency: Keeps documentation consistent across your codebase.
- Get the ChatGPT api-key and save it in your settings. [https://platform.openai.com/api-keys]
- Install the tsDoc-generator extension from the Visual Studio Code Marketplace.
- Open a TypeScript file in Visual Studio Code.
- Drag your cursor over the TypeScript interface or type you wish to document.
- Press cmd+e on macOS or ctrl+e on Windows/Linux to generate tsDOC comments automatically.
| 버전 | GIF 미리보기 | 설명 |
|---|---|---|
| Block | |
Block 버전은 선택한 타입 위에 블록 형태로 tsDOC 주석을 생성합니다. 코드 구조를 한 눈에 파악하기 쉬워 코드의 이해를 돕습니다. |
| Inline | |
Inline 버전은 각 프로퍼티나 메서드마다 바로 위에 tsDOC 주석을 추가합니다. 세부적인 정보를 제공하여 개별 요소에 대한 이해를 깊게 합니다. |
tsDoc Generator는 TypeScript 인터페이스와 타입에 대한 tsDOC 주석을 자동으로 생성해주는 Visual Studio Code 확장 프로그램입니다. 타입 위에 커서를 드래그한 다음 macOS에서는 cmd+e, Windows와 Linux에서는 ctrl+e를 누르기만 하면, 손쉽게 상세한 문서를 생성할 수 있어 시간을 절약하고 코드의 가독성을 향상시킬 수 있습니다. 이 확장 프로그램은 모든 규모의 프로젝트에 이상적이며, 일관되고 유지보수가 용이한 문서를 보장합니다.
- 간편한 문서화: 간단한 키보드 단축키로 tsDOC 주석 생성.
- 다중 플랫폼 지원: macOS, Windows, Linux에서 작동.
- 가독성 향상: 상세한 문서 제공으로 코드 가독성 향상.
- 시간 절약: 문서화 과정을 자동화하여 개발자의 시간 절약.
- 일관성: 코드베이스 전체에 걸쳐 문서의 일관성 유지.
- ChatGPT api-key를 가져와서 설정에 저장합니다. [https://platform.openai.com/api-keys]
- Visual Studio Code 마켓플레이스에서 tsDoc-generator 확장 프로그램을 설치하세요.
- Visual Studio Code에서 TypeScript 파일을 엽니다.
- 문서화하고 싶은 TypeScript 인터페이스나 타입 위에 커서를 드래그하세요.
- macOS에서는 cmd+e, Windows/Linux에서는 ctrl+e를 눌러 자동으로 tsDOC 주석을 생성하세요.