Inline NgDoc Viewer
A VS Code extension that provides inline documentation for Angular classes and services.
⚠️ Disclaimer ⚠️
This is NOT an official Angular extension. It is a community-developed tool designed to enhance the Angular development experience.
Features
- Hover over Angular classes and services to see their documentation and usage examples
- Comprehensive documentation coverage for:
- Core Angular services (HttpClient, ChangeDetectorRef, NgZone)
- Forms (FormBuilder, FormGroup, FormControl, Validators)
- Routing (Router, ActivatedRoute, Route)
- Structure (@Component, @Directive, @Injectable, Input, Output)
- Security (DomSanitizer, SafeHtml)
- Lifecycle hooks (OnInit, OnDestroy, OnChanges, AfterViewInit, AfterContentInit)
- RxJS operators (map, filter, switchMap)
- Structural directives (ngIf, ngFor, ngSwitch)
- Testing utilities (TestBed, ComponentFixture)
- Common modules (BrowserModule, CommonModule)
Installation
- Open VS Code
- Press
Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (Mac) to open the Extensions view
- Search for "Inline NgDoc Viewer"
- Click Install
Usage
Simply hover over any supported Angular class or service in your TypeScript/JavaScript files to see its documentation and usage examples.
Documentation & Resources
Requirements
- VS Code 1.60.0 or higher
- TypeScript or JavaScript files
Extension Settings
This extension contributes the following settings:
inlineNgDocViewer.enable: Enable/disable the extension
Known Issues
- Currently supports a limited set of Angular services
- Documentation is static and not pulled from the official Angular documentation
Release Notes
1.0.0
- Enhanced documentation coverage for Angular core concepts
- Added documentation for RxJS operators and patterns (map, filter, switchMap)
- Added documentation for Angular structural directives (ngIf, ngFor, ngSwitch)
- Added documentation for Angular testing utilities (TestBed, ComponentFixture)
- Added documentation for Angular common modules (BrowserModule, CommonModule)
- Added documentation for Angular lifecycle hooks (OnInit, OnDestroy, OnChanges, AfterViewInit, AfterContentInit)
- Added documentation for Angular security features (DomSanitizer, SafeHtml)
- Better code examples with practical use cases
- More comprehensive documentation for each Angular feature
- Enhanced hover documentation formatting
- Organized documentation into clear categories
- Added more detailed examples for each feature
0.0.1
Initial release of Inline NgDoc Viewer
Acknowledgments
- Thanks to the Angular team for their excellent documentation and framework
- Thanks to the VS Code team for providing a robust extension API
- Thanks to all contributors who help improve this extension
| |
