API Extractor

API Extractor

API Extractor به شما کمک می کند تا کتابخانه های TypeScript را بهتر بنویسید: این امضاهای نوع صادر شده شما را تجزیه و تحلیل می کند و (1) یک وب سایت اسناد API تولید می کند ، (2) یک پرونده "rollup" .d.ts ایجاد می کند ، و (3) یک گزارش API برای تسهیل روابط عمومی ایجاد می کند.بررسی
API Extractor به توسعه دهندگان TypeScript کمک می کند تا سطح API را برای کتابخانه خود مدیریت کنند.به صورت بسته NPM "@ microsoft / api-استخراج" توزیع می شود.این سه نوع خروجی مختلف را تولید می کند: - گزارش API - استخراج API می تواند تمام صادرات از محل ورودی اصلی پروژه شما را ردیابی کرده و گزارشی تولید کند تا به عنوان مبنای گردش کار بررسی API مورد استفاده قرار گیرد.- .d.ts Rollaps - شبیه به این که چگونه Webpack می تواند تمام پرونده های JavaScript را در یک بسته نرم افزاری برای توزیع قرار دهد "،" API Extractor "می تواند اظهارات TypeScript شما را در یک پرونده .d.ts منفرد کند.این پرونده را می توان به منظور حذف اعلامیه های مشخص شده با استفاده از برچسب های TSDoc مانندbeta "یاinternal. - مستندات API - این ابزار برای هر یك از پروژه های خود یك پرونده JSON" Doc Document "ایجاد می كند .این پرونده JSON حاوی امضاهای نوع استخراج شده ونظرات توضیحات: ابزار همراه "api-documenter" می تواند از این پرونده ها برای تولید یک وب سایت مرجع API استفاده کند ، یا می توانید از آنها به عنوان ورودی برای خط لوله مستند سازی سفارشی استفاده کنید.
api-extractor

سایت اینترنتی:

امکانات

دسته بندی ها

گزینه های API Extractor برای همه سیستم عامل های دارای مجوز

Compodoc

Compodoc

Compodoc یک ابزار مستند سازی برای برنامه های Angular است.این یک مستندات ثابت از برنامه شما ایجاد می کند. ویژگی ها:
ESDoc

ESDoc

تولید کننده اسناد و مدارک خوب برای JavaScript.
TypeDoc

TypeDoc

تولید کننده اسناد برای پروژه های TypeScript.
Docma

Docma

Docma ابزاری قدرتمند برای تولید اسناد HTML زیبا از فایلهای Javascript (JSDoc) ، Markdown و HTML است.
Dgeni

Dgeni

dgeni - مولد اسناد انعطاف پذیر JavaScript که توسط AngularJS ، Protractor و سایر پروژه های JS استفاده می شود
Smartcar

Smartcar

در Smartcar ، ما به توسعه دهندگان توان می دهیم تا آینده تحرک را بسازند.