---
title: Code documentation
localeTitle: وثائق قانون
---
## وثائق قانون

وثائق التعليمات البرمجية هي طريقة مطوري كتابة التعليمات البرمجية الخاصة بهم لإنشاء أفضل إصدارات وظائفهم المحتملة. تتيح وثائق الكود للمبتدئ الحصول على راحة مع تخصيص الوحدة النمطية الخاصة ، أو الوظيفة ، إلخ ، من أجل لغة برمجة معينة.ومن المستحسن دائمًا الذهاب مع الوثائق قبل تصحيح الكود ، وهذا يساعدك على التصحيح بفعالية. على سبيل المثال ، يجب عليك القدرة على تمرير الشفرة إلى مبتدئ مطلق ويجب أن يكونوا قادرين على المتابعة من خلال التعليقات وأسماء المتغيرات المناسبة ورمز الهيكلة بطريقة متباعدة وقابلة للقراءة.

قد تصبح فكرة مهمة للغاية للتخلص من التعليق على وظائفك ، وحلقاتك ، وإعلاناتك ، ومعالجة التعليقات كجزء من شفرة المصدر ، مثلما يجب أن تكون الشفرة العادية.

![مثال على التعليق في العالم الحقيقي](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg)

#### معلومات اكثر: