typer(1) Erlang Module Definition typer(1)

typer - حاشیه‌نویس نوع داده برای برنامه‌های ارلنگ

ابزار TypEr اطلاعات نوع داده (type) را برای ماژول‌های ارلنگ (Erlang) نمایش می‌دهد. علاوه بر این، می‌تواند کد فایل‌ها را با این‌گونه اطلاعات نوع داده حاشیه‌نویسی (annotate) کند.

ابزار TypEr از طریق خط فرمان استفاده می‌شود. این بخش توضیح مختصری از گزینه‌ها را ارائه می‌دهد. اطلاعات مشابه را می‌توان با نوشتن دستور زیر در شل دریافت کرد:

typer --help

نحوه استفاده:

typer [--help] [--version] [--plt PLT] [--edoc]
      [--show | --show-exported | --annotate | --annotate-inc-files | --annotate-in-place]
      [-Ddefine]* [-I include_dir]* [-pa dir]* [-pz dir]*
      [-T application]* file* [-r directory*]

نکته: علامت * نشان می‌دهد که تکرار چندباره این گزینه امکان‌پذیر است.

گزینه‌ها:

-r

جستجوی بازگشتی در دایرکتوری‌ها برای یافتن فایل‌های .erl موجود در آن‌ها. اگر فهرستی از فایل‌ها ارائه شده باشد، این گزینه باید بعد از آن‌ها قرار گیرد.

--show

چاپ مشخصات نوع داده برای تمام توابع در خروجی استاندارد (stdout). (این رفتار پیش‌فرض است و این گزینه واقعاً الزامی نیست.)

--show-exported (or show_exported)

مشابه --show، اما مشخصات نوع داده را فقط برای توابع صادرشده (exported) چاپ می‌کند. مشخصات به صورت مرتب‌شده بر اساس حروف الفبای نام تابع نمایش داده می‌شوند.

--annotate

حاشیه‌نویسی فایل‌های مشخص‌شده با مشخصات نوع داده.

--annotate-inc-files

مشابه --annotate، اما تمام فایل‌های -include() را نیز در کنار فایل‌های .erl حاشیه‌نویسی می‌کند. (از این گزینه با احتیاط استفاده کنید — این گزینه به خوبی آزمایش نشده است.)

--annotate-in-place

حاشیه‌نویسی مستقیم در فایل‌های کد منبع اصلی، به جای قرار دادن فایل‌های حاشیه‌نویسی‌شده در یک دایرکتوری مجزا. (از این گزینه با احتیاط استفاده کنید — این گزینه به خوبی آزمایش نشده است.)

--edoc

چاپ اطلاعات نوع داده به عنوان کامنت‌های @spec ابزار Edoc، نه به صورت مشخصات نوع داده.

--plt

استفاده از فایل PLT دیالایزر (Dialyzer) مشخص‌شده به جای فایل پیش‌فرض.

-T file*

فایل(های) مشخص‌شده از قبل حاوی مشخصات نوع داده هستند و برای چاپ مشخصات سایر فایل‌ها، به اطلاعات آن‌ها اعتماد می‌شود. (می‌توان چندین فایل یا دایرکتوری را با فاصله مشخص کرد.)

-Dname (or -Dname=value)

ارسال نام(های) تعریف‌شده به TypEr. (**)

-I

ارسال include_dir به TypEr. (**)

-pa dir

افزودن dir به مسیر (path) ارلنگ. این گزینه هنگام تحلیل فایل‌هایی که از دستورات -include_lib() یا تحولات تجزیه (parse transforms) استفاده می‌کنند، مفید است.

-pz dir

افزودن dir به انتهای مسیر (path) ارلنگ. این گزینه هنگام تحلیل فایل‌هایی که از دستورات -include_lib() یا تحولات تجزیه (parse transforms) استفاده می‌کنند، مفید است.

--version (or -v)

چاپ نسخه TypEr و برخی اطلاعات بیشتر و خروج.

نکته: ** گزینه‌های -D و -I دقیقاً مشابه با erlc عمل می‌کنند.

dialyzer 6.0.2 Ericsson AB