Enhance your Angular development with instant inline documentation. View Angular API docs, examples, and best practices directly in your code editor while typing. Supports core Angular services, RxJS, forms, routing, and more.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
⚡ Boost your Angular development productivity with instant inline documentation! View Angular API docs, examples, and best practices directly in your code editor while typing.
⚠️ Disclaimer ⚠️
This is NOT an official Angular extension. It is a community-developed tool designed to enhance the Angular development experience.
✨ Features
🚀 Instant Documentation: Hover over Angular classes and services to see comprehensive documentation
📚 Extensive Coverage: Documentation for all major Angular concepts:
💡 Smart Examples: Practical code examples for each feature
🎨 Clean Formatting: Well-organized and easy-to-read documentation
⚡ Zero Configuration: Works out of the box
🚀 Quick Start
Open VS Code
Press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (Mac)
Search for "Inline NgDoc Viewer"
Click Install
Start coding! Just hover over any Angular class or service
📋 Requirements
VS Code 1.60.0 or higher
TypeScript or JavaScript files
Angular project
⚙️ Extension Settings
This extension contributes the following settings:
inlineNgDocViewer.enable: Enable/disable the extension (default: true)
🔍 Usage Examples
// Hover over HttpClient to see its documentation
constructor(private http: HttpClient) {}
// Hover over FormBuilder to see form creation examples
constructor(private fb: FormBuilder) {
this.form = this.fb.group({
name: ['', Validators.required]
});
}
// Hover over Router to see navigation examples
constructor(private router: Router) {
this.router.navigate(['/dashboard']);
}
