نحوه نوشتن داکیومنت برای اپلیکیشن توسعه یافته

دوست عزیز مستند سازی در برنامه نویسی یه سری قانون هایی داره اما شما خودتون هم هر ایده دیگه ای دارید میتونید در مستند سازی به کار ببرید
یکی از قواعد مستند سازی کد اینه که شما کد ها رو خوانا و قابل فهم بنویسید
یعنی تا جایی که میتونید لقمه رو دور سر نگردونده باشید که کسی که داره کد رو میخونه یکدفعه خط رو گم نکنه که نفهمه مثلا یک متود از کجا اومده یا داده از کجا گرفته شده
البته یکی از پیش نیاز های خوانا بودن کد حرفه ای بودن برنامه نویسه چون مثلا یکی مثل خود من که حرفه ای نیستم به جای اینکه کارو با یک روش ساده انجام بدم لقمه رو دور سر میگردونم و کسی که کد رو میبینه اصلا نمیفهمه چی شده هنر برنامه نویسی اینه که از ساده ترین راه ممکن مشکل رو حل کنید که نه به شما فشار بیاد نه به پردازنده نه به حافظه
دوم اینه که درصورت پیچیده شدن یک کد در یک جا یا نوشتن یک متد و یا هرجایی که درکدش برای به غیر از شما قابل فهم نیست باید حتما در بالای متد یا کدتون توضیحات ذکر کنید
سومم اینکه نام متغیر یا هر چیز دیگه رو قابل فهم بیان کنید مثلا  نیاید یه متغیر اینتیجر با نام x تعریف کنید نامش باید مطابق با کاری باشه که میکنه این باید درمورد چیزای دیگه هم صدق کنه مثلا یک شیع دوربین رو که تعریف کردید اسمشو بذارید camera که معلوم باشه دوربینه
من تا اینجا میدونم حالا دوستان دیگه اگر چیزی اضاف تر میدونند براتون توضیح میدن

روید باکس...