kkoomen/vim-doge
این افزونه ویم یک ماشین تولید مستندات هوشمند برای بیش از ۲۰ زبان برنامهنویسی است
با یک دکمه، مستندات حرفهای و استاندارد از کد شما تولید میکند
کاربرد:
کمک میکنه تا بدون دردسر و به صورت خودکار مستندات تمیز و خوانا برای توابع، کلاسها و متغیرها بنویسید
از جمله زبانهای پشتیبانیشده: Python، JavaScript، PHP، Ruby، Go، C++ و بسیاری دیگر
در چه شرایطی بهتره استفاده شود؟
وقتی روی پروژههای بزرگ کار میکنید و نیاز به مستندسازی سریع و یکنواخت دارید
یا وقتی میخواید کد شما برای دیگران قابل فهمتر و حرفهایتر به نظر برسه
چند مثال از موارد استفاده:
- تولید مستندات Javadoc برای توابع جاوا با یک فشار کلید
- ایجاد توضیحات خودکار برای توابع پایتون با فرمت Sphinx
- مستندسازی توابع در PHP با استاندارد PHPDoc ️
- ##vim
- ##documentation
- ##productivity
- ##developer
- ##code
- ##automation
- ##programming
- ##text
- ##vim
