gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Better explanation with resources (#25239)

Browse Source
This commit is contained in:
Ahmed Tharwat
2019-08-08 00:55:46 +02:00
committed by Randell Dawson
parent d312e29d44
commit d9ec76ba3a
1 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
guide/arabic/documentation/index.md
View File

@ -1,13 +1,24 @@
---
title: Code documentation
localeTitle: وثائق قانون
localeTitle: توثيق البرمجيات
---
## وثائق قانون
## توثيق البرمجيات
وثائق التعليمات البرمجية هي طريقة مطوري كتابة التعليمات البرمجية الخاصة بهم لإنشاء أفضل إصدارات وظائفهم المحتملة. تتيح وثائق الكود للمبتدئ الحصول على راحة مع تخصيص الوحدة النمطية الخاصة ، أو الوظيفة ، إلخ ، من أجل لغة برمجة معينة.ومن المستحسن دائمًا الذهاب مع الوثائق قبل تصحيح الكود ، وهذا يساعدك على التصحيح بفعالية. على سبيل المثال ، يجب عليك القدرة على تمرير الشفرة إلى مبتدئ مطلق ويجب أن يكونوا قادرين على المتابعة من خلال التعليقات وأسماء المتغيرات المناسبة ورمز الهيكلة بطريقة متباعدة وقابلة للقراءة.
توثيق الكود او توثيق البرمجيات هي عملية كتابة نصوص يتم إرفاقها مع الكود أو البرنامج. تلك النصوص هي كتابات نصية توضيحية تشرح آلية عمل البرنامج أو الكود، وكيفية استخدامه، والتعديل فيه اذا كان ذلك متاحاً، او كان منتج برمجى مفتوح المصدر.
تلك العملية هي إحدى المراحل الأساسية من مراحل هندسية البرمجيات، وذلك لأهميتها التي تتيح عملية فهم البرنامج أو الكود، وكيفية التعامل معه، حتى يكون على قدر كافى من الوضوح.
التوثيق البرمجى له نوعان رئيسيان:
• توثيق المنتج: وهى عملية توثيق لآلية عمل المنتج البرمجى، وعملية تصنيعه، وتوضيح كل طرق التعامل معه واستخدامه. وتنقسم تلك العملية الى نوعان:
 توثيق النظام
 توثيق الستخدم
• التوثيق العملى: وهى عملية توثيق كل الخطوات الإدارية والتخطيطية اللازمة التي تم تطوير المنتج البرمجى بناءً عليها.
قد تصبح فكرة مهمة للغاية للتخلص من التعليق على وظائفك ، وحلقاتك ، وإعلاناتك ، ومعالجة التعليقات كجزء من شفرة المصدر ، مثلما يجب أن تكون الشفرة العادية.
![مثال على التعليق في العالم الحقيقي](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg)
#### معلومات اكثر:
#### معلومات اكثر:
1- https://ar.wikipedia.org/wiki/%D8%AA%D9%88%D8%AB%D9%8A%D9%82_%D8%A7%D9%84%D8%A8%D8%B1%D9%85%D8%AC%D9%8A%D8%A7%D8%AA
2- https://www.altexsoft.com/blog/business/software-documentation-types-and-best-practices/