×
شرکت فناوری نوآوران پارسیس

 

  • دارای گواهی رتبه بندی احراز صلاحیت  در شورای عالی انفورماتیک کشور
  • عضور سازمان نظام صنفی رایانه ای کشور
تماس با ما
  • ۰۲۱۸۸۷۱۲۰۹۰-۸۸۵۱۵۱۵۵
  • info@parsisco.net
  • داخلی 103
شبکه های اجتماعی
  • واتساپ
  • تلگرام
  • اینستاگرام
  • توییتر
Parsis Design Department | copyright 2019 all rights reserved

ورود به حساب کاربری خود برای دسترسی به ویژگی های متنوع

*

code

رمز عبور خود را فراموش کرده اید؟

جزئیات حساب خود را فراموش کرده اید؟

اوه، صبر کن، یادم اومد!
  • پیشتیبانی

شرکت توسعه فناوری نوآوران پارسیس

CONTACT US / GET A QUOTE
  • خانه
  • گروه توسعه نرم افزار پارسیس
    • گروه نرم افزارهای مالی و مدیریتی
    • برنامه‌های تحت وب و موبایل
    • طراحی وب سایت و برنامه‌های تحت وب
  • گروه صورتهای مالی و تلفیقی پارسیس
  • سامانه صورتهای مالی و تلفیقی پارسیس
  • اخبار و مقالات
    • نرم افزار مالی
    • نرم افزار تحت وب
    • موبایل اپلیکیشن
  • درباره ما
  • تماس با ما
  • خدمات ما
  • درخواست دمو
  • خانه
  • Blog
  • دسته‌بندی نشده
  • داکیومنت نویسی در PHP و کار با phpDocumentor
 
sadeghi
پنج‌شنبه, 28 نوامبر 2019 / منتشر شده در دسته‌بندی نشده, نرم افزار تحت وب

داکیومنت نویسی در PHP و کار با phpDocumentor

phpDocumentor  به شما این قابلیت رو میده که از پروژه PHP تون یک فایل داکیومنت خروجی بگیرید.

برای شروع اول باید یاد بگیریم که درست داکیومنت بنویسیم – البته اگر تا به حال می نوشتیم – داکیومنت نوشتن از چندین نظر خیلی خوبه و به کار مون میاد:

اول اینکه اگر پروژه بزرگ و دارای کدهای پیچیده باشه و مخصوصا پس از گذشت مدتی بهش مراجعه کنیم، در درک بهتر اینکه چیکار کردیم، خیلی بهمون کمک می کنه.

دوم اینکه اگر روزی ادامه یک پروژه رو به کس دیگری واگذار کردیم، به درک بهتر کد برای انتقال دانش ادامه اون پروژه به فرد جدید خیلی مفید هست.

و سوم اینکه خیلی از جاها یک داکیومنت خوب می تونه باعث جلوگیری از باگ ها بشه، به اینصورت که نکاتی که ممکنه در انجام تغییرات بعدی فراموش بشه رو در جای درست یادآوری کنه…

همه اینها به شرطی هست که به داکیومنت نویسی و آپدیت اون در طول انجام پروژه، همه تیم پایبند باشن و دلسوزانه و درست انجام بشه.

و اما چه مواردی نیاز به نوشتن داکیومنت دارن؟

  • Function
  • Constant
  • Class
  • Interface
  • Trait
  • Class constant
  • Property
  • Method

And Files

اگر با هریک از موارد بالا آشنایی ندارید، می تونید در سایت php.net توضیحات مرتبط اون رو ببینید.

و اما ساختار داکیومنت نویسی

داکیومنت دارای 3 بخش اصلی هست:

  • خلاصه (Summary): معمولا یک خط و توضیح مختصری در رابطه با عنصری که براش داک می نویسیم. به دو روش از توضیحات جدا میشه، یک:آخر خلاصه نقطه و خط بعد توضیحات؛ دوم: با یک خط خالی بین خلاصه و توضیحات.
  • توضیحات(Description): (دلخواه است – optional) توضیحات مفصل با جزئیات بیشتر، احتمالا همراه با مثال و…
  • مجموعه تگ (A series of tags): تگ ها اطلاعات بیشتری در باره ساختار اصلی میدن، اطلاعات از جمله properies و arguments و…

همانطور که توجه کردید، داکیومنت ها با  /**  شروع و با  */  به پایان میرسن.

تگ ها:

28 نوع تگ تعریف شدن که در زیر لیست شدن و برای اطلاعات بیشتر و توضیحاتشون به آدرس این لینک مراجعه کنید.

می تونید با مراجعه به سایت phpdoc از آنجا دانلود کنید.

ایجاد فایل داکیومنت هم باهاش خیلی آسونه و کافیه با سه دستور زیر آشنا باشید:

-d for a directory,

-f for a file

-t tell it to output your documentation to a folder of your liking. (If you want you can even omit the -t option, in which case the output will be written to a subfolder called output.)

مثال:

در ترمینال میزنید:

$ phpdoc -d ./src -t ./docs/api

این یعنی درون پوشه /src پروژه شما قرار داره و خروجی داکیومنت رو در پوشه /docs/api ذخیره کنه.

برچسب زیر: PHP, phpDocumentor, برنامه نویسی, برنامه نویسی تحت وب, داکیومنت نویسی

چیزی که می توانید بعد بخوانید

پشتیانی مشتریان
گروه خدمات پشتیبانی مشتریان:
داشبورد گزارشات مدیریتی
تست کارایی و استرس برای برنامه‌های تحت وب

پاسخی بگذارید لغو پاسخ

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

*

code

آخرین مطالب

  • تجزیه و تحلیل صورتهای مالی

    انواع روشهای تجزیه و تحلیل صورتهای مالی شرکتها

    تجزیه و تحلیل صورتهای مالی به روش‌های مختلف و ب...
  • صورتهای مالی نمونه سازمان حسابرسی

    صورتهای مالی نمونه سازمان حسابرسی (۱۳۹۸)

    بر اساس استاندارد های حسابداری جدید تعداد صورته...
  • accounting 1

    تحلیل و بررسی صورت جریان نقدی شرکتها (Cash flow of companies)

    وضعیت جریان نقدی نشان دهنده چگونگی دخل و خرج سر...
  • خدمات حسابداری

    انواع خدمات حسابداری

    خدمات حسابداری به خدمات مالی گفته می شود که برا...
  • استانداردهای گزارشگری مالی بین المللی (IFRS)

    تفاوت‌ها بین استاندارد حسابداری ايران و IFRS

    با پذيرش IFRS، یک شرکت می‌تواند صورت‌های مالی خ...

آخرین دیدگاه‌ها

  • Putin در طراحی تجربه کاربری(UX) و رابط کاربری (UI)

آرشیو ها

  • اکتبر 2020
  • سپتامبر 2020
  • آگوست 2020
  • جولای 2020
  • ژوئن 2020
  • می 2020
  • آوریل 2020
  • دسامبر 2019
  • نوامبر 2019
  • اکتبر 2019
  • سپتامبر 2019

دسته بندی ها

  • توسعه نرم افزار
  • دسته‌بندی نشده
  • سامانه پیشرفته مالی و مدیریتی پارسیس
  • سامانه صورتهای مالی و تلفیقی پارسیس
  • شبکه و سخت افزار
  • فناوری
  • مراکز داده
  • موبایل اپلیکیشن
  • نرم افزار تحت وب
  • نرم افزار مالی

اطلاعات

  • ورود
  • خوراک ورودی‌ها
  • خوراک دیدگاه‌ها
  • وردپرس

آخرین مطالب

  • تجزیه و تحلیل صورتهای مالی

    انواع روشهای تجزیه و تحلیل صورتهای مالی شرکتها

    0 نظر
  • صورتهای مالی نمونه سازمان حسابرسی

    صورتهای مالی نمونه سازمان حسابرسی (۱۳۹۸)

    0 نظر
  • accounting 1

    تحلیل و بررسی صورت جریان نقدی شرکتها (Cash flow of companies)

    0 نظر
  • خدمات حسابداری

    انواع خدمات حسابداری

    0 نظر
  • استانداردهای گزارشگری مالی بین المللی (IFRS)

    تفاوت‌ها بین استاندارد حسابداری ايران و IFRS

    0 نظر
شرکت فناوری نوآوران پارسیس

 

  • دارای گواهی رتبه بندی احراز صلاحیت  در شورای عالی انفورماتیک کشور
  • عضور سازمان نظام صنفی رایانه ای کشور
تماس با ما
  • ۰۲۱۸۸۷۱۲۰۹۰-۸۸۵۱۵۱۵۵
  • info@parsisco.net
  • داخلی 103
شبکه های اجتماعی
  • واتساپ
  • تلگرام
  • اینستاگرام
  • توییتر
Parsis Design Department | copyright 2019 all rights reserved
3 رتبه برتر