binhdinhhuynh
New member
## Mô tả Mã nguồn quy ước
Mô tả các quy ước là một tập hợp các quy tắc xác định cách viết các mô tả của các tạo tác phần mềm.Chúng được sử dụng để đảm bảo rằng các mô tả là nhất quán và dễ hiểu.
Có một số quy ước mô tả khác nhau có sẵn, mỗi quy tắc có bộ quy tắc riêng.Một số quy ước phổ biến nhất bao gồm:
* [Phong cách DocString của Google] (styleguide)
* [Phong cách DocString của Numpy] (Style guide — numpydoc v1.7.0rc0.dev0 Manual)
* [PEP 257] (PEP 257 – Docstring Conventions | peps.python.org)
Khi chọn một quy ước mô tả, điều quan trọng là phải xem xét nhu cầu của dự án của bạn.Nếu bạn đang làm việc trong một dự án sẽ được sử dụng bởi nhiều người, điều quan trọng là chọn một quy ước dễ hiểu.Nếu bạn đang làm việc trong một dự án sẽ chỉ được sử dụng bởi một nhóm nhỏ người, bạn có thể thoát khỏi việc sử dụng một quy ước súc tích hơn.
Một khi bạn đã chọn một quy ước mô tả, điều quan trọng là phải tuân theo nó một cách nhất quán.Điều này sẽ giúp đảm bảo rằng các mô tả về các hiện vật phần mềm của bạn là nhất quán và dễ hiểu.
Dưới đây là một số mẹo để viết mô tả tốt:
* Giữ các mô tả ngắn gọn và súc tích.
* Sử dụng ngôn ngữ rõ ràng và súc tích.
* Sử dụng giọng nói đang hoạt động.
* Sử dụng các ví dụ để minh họa điểm của bạn.
* Sử dụng liên kết đến các tài nguyên bên ngoài khi thích hợp.
## hashtags
* #Kỹ thuật phần mềm
* #tài liệu
* #StyleGuides
* #DocStrings
* #Python
=======================================
## Description Convention Source Codes
Description conventions are a set of rules that define how to write the descriptions of software artifacts. They are used to ensure that the descriptions are consistent and easy to understand.
There are a number of different description conventions available, each with its own set of rules. Some of the most common conventions include:
* [Google's docstring style](https://google.github.io/styleguide/pyguide.html#docstrings)
* [NumPy's docstring style](https://numpydoc.readthedocs.io/en/latest/format.html)
* [PEP 257](https://www.python.org/dev/peps/pep-0257/)
When choosing a description convention, it is important to consider the needs of your project. If you are working on a project that will be used by a wide range of people, it is important to choose a convention that is easy to understand. If you are working on a project that is only going to be used by a small group of people, you may be able to get away with using a more concise convention.
Once you have chosen a description convention, it is important to follow it consistently. This will help to ensure that the descriptions of your software artifacts are consistent and easy to understand.
Here are some tips for writing good descriptions:
* Keep the descriptions short and concise.
* Use clear and concise language.
* Use active voice.
* Use examples to illustrate your points.
* Use links to external resources when appropriate.
## Hashtags
* #SoftwareEngineering
* #Documentation
* #StyleGuides
* #DocStrings
* #Python
Mô tả các quy ước là một tập hợp các quy tắc xác định cách viết các mô tả của các tạo tác phần mềm.Chúng được sử dụng để đảm bảo rằng các mô tả là nhất quán và dễ hiểu.
Có một số quy ước mô tả khác nhau có sẵn, mỗi quy tắc có bộ quy tắc riêng.Một số quy ước phổ biến nhất bao gồm:
* [Phong cách DocString của Google] (styleguide)
* [Phong cách DocString của Numpy] (Style guide — numpydoc v1.7.0rc0.dev0 Manual)
* [PEP 257] (PEP 257 – Docstring Conventions | peps.python.org)
Khi chọn một quy ước mô tả, điều quan trọng là phải xem xét nhu cầu của dự án của bạn.Nếu bạn đang làm việc trong một dự án sẽ được sử dụng bởi nhiều người, điều quan trọng là chọn một quy ước dễ hiểu.Nếu bạn đang làm việc trong một dự án sẽ chỉ được sử dụng bởi một nhóm nhỏ người, bạn có thể thoát khỏi việc sử dụng một quy ước súc tích hơn.
Một khi bạn đã chọn một quy ước mô tả, điều quan trọng là phải tuân theo nó một cách nhất quán.Điều này sẽ giúp đảm bảo rằng các mô tả về các hiện vật phần mềm của bạn là nhất quán và dễ hiểu.
Dưới đây là một số mẹo để viết mô tả tốt:
* Giữ các mô tả ngắn gọn và súc tích.
* Sử dụng ngôn ngữ rõ ràng và súc tích.
* Sử dụng giọng nói đang hoạt động.
* Sử dụng các ví dụ để minh họa điểm của bạn.
* Sử dụng liên kết đến các tài nguyên bên ngoài khi thích hợp.
## hashtags
* #Kỹ thuật phần mềm
* #tài liệu
* #StyleGuides
* #DocStrings
* #Python
=======================================
## Description Convention Source Codes
Description conventions are a set of rules that define how to write the descriptions of software artifacts. They are used to ensure that the descriptions are consistent and easy to understand.
There are a number of different description conventions available, each with its own set of rules. Some of the most common conventions include:
* [Google's docstring style](https://google.github.io/styleguide/pyguide.html#docstrings)
* [NumPy's docstring style](https://numpydoc.readthedocs.io/en/latest/format.html)
* [PEP 257](https://www.python.org/dev/peps/pep-0257/)
When choosing a description convention, it is important to consider the needs of your project. If you are working on a project that will be used by a wide range of people, it is important to choose a convention that is easy to understand. If you are working on a project that is only going to be used by a small group of people, you may be able to get away with using a more concise convention.
Once you have chosen a description convention, it is important to follow it consistently. This will help to ensure that the descriptions of your software artifacts are consistent and easy to understand.
Here are some tips for writing good descriptions:
* Keep the descriptions short and concise.
* Use clear and concise language.
* Use active voice.
* Use examples to illustrate your points.
* Use links to external resources when appropriate.
## Hashtags
* #SoftwareEngineering
* #Documentation
* #StyleGuides
* #DocStrings
* #Python
