|
1 | | -<h1 align="center"> PYTHON DOCSTRING [TR]</h1> |
2 | | - |
3 | | -<br> |
4 | | - |
5 | | -Docstring yapısı, Python projelerinde kodun amacını, kullanımını ve özelliklerini açıklamak için kullanılır. |
6 | | - |
7 | | -Aşağıda, bir Python projesi için örnek bir docstring yapısı verilmiştir. |
8 | | - |
9 | | -Bu yapıyı kendi projenize uyarlayabilirsiniz. |
10 | | - |
11 | | -> *author:* [mefamex](https://mefamex.com) <br> *last_modify: 2025-07-20* |
12 | | -
|
13 | | - |
14 | | -<hr><br><br> |
15 | | - |
16 | | -```python |
17 | | -# -*- coding: utf-8 -*- |
18 | | -#!/usr/bin/env python3 |
19 | | - |
20 | | -""" |
21 | | -=========================================================== |
22 | | - ornek-proje |
23 | | -=========================================================== |
24 | | -
|
25 | | -Description: |
26 | | - Bu proje, [kısa bir şekilde projenin amacını belirtin] amacıyla geliştirilmiştir. |
27 | | - Proje, [projedeki ana özellikler ve işlevler listesi] özelliklerine sahiptir. |
28 | | -
|
29 | | -Author: |
30 | | - Ad (posta@posta.com) (https://web_sitesi.com) |
31 | | -
|
32 | | -Features: |
33 | | - - Ozellikleri madde madde veya metin olarak yazabilirsiniz. |
34 | | -
|
35 | | -Modules: |
36 | | - - modul1: [Modul 1 açıklaması] |
37 | | - - modul2: [Modul 2 açıklaması] |
38 | | - - ... |
39 | | -
|
40 | | -Classes: |
41 | | - - Sinif1: [Sinif1 açıklaması] |
42 | | - - Sinif2: [Sinif2 açıklaması] |
43 | | - - ... |
44 | | -
|
45 | | -Functions: |
46 | | - - fonksiyon1(parametre1, parametre2): [Fonksiyon1 açıklaması] |
47 | | - - fonksiyon2(parametre1): [Fonksiyon2 açıklaması] |
48 | | - - ... |
49 | | -
|
50 | | -Usage: |
51 | | - [Projeyi nasıl kullanacağınızı açıklayın. Örnekler ekleyebilirsiniz.] |
52 | | -
|
53 | | -Requirements: |
54 | | - - Python 3.8 veya üstü |
55 | | - - Dependencies: |
56 | | - - paket1 (>= sürüm) |
57 | | - - paket2 (latest) |
58 | | - - ... |
59 | | -
|
60 | | -Installation: |
61 | | - - Proje klonlama: `git clone [repo adresi]` |
62 | | - - Gerekli bağımlılıkları kurma: `pip install -r requirements.txt` |
63 | | -
|
64 | | -Documentation: |
65 | | - - Detaylı belgeler için: `README.md` |
66 | | -
|
67 | | -License: |
68 | | - MIT Lisansı (https://opensource.org/licenses/MIT) |
69 | | -
|
70 | | -Changelog: |
71 | | - - 1.0.0 (2024-02-03): İlk sürüm |
72 | | - - 1.1.0 (2024-02-04): [Yapılan değişiklikler] |
73 | | - - ... |
74 | | -
|
75 | | -Contributors: |
76 | | - [Projeye katkıda bulunanların adları ve iletişim bilgileri] |
77 | | -
|
78 | | -Contact: |
79 | | - [Projeye ilişkin sorular için e-posta adresi veya diğer iletişim bilgileri] |
80 | | -
|
81 | | -Additional Information: |
82 | | - [Projeye ilişkin ek bilgiler, bağlantılar, belgeler vb.] |
83 | | -
|
84 | | -Notes: |
85 | | - - Bu proje, [proje amacını ve kullanımını açıklayan kısa bir not] içermektedir. |
86 | | - - Proje, [proje ile ilgili önemli notlar veya uyarılar] içermektedir. |
87 | | -
|
88 | | -Disclaimer and Legal Notice: |
89 | | - Bu yazılım, herhangi bir garanti olmaksızın "olduğu gibi" sağlanmaktadır. Yazar, bu yazılımın kullanımı sonucunda oluşabilecek herhangi bir zarardan sorumlu değildir. Kullanıcılar, yazılımı kendi sorumlulukları altında kullanmalıdır. |
90 | | - Bu yazılım, açık kaynak lisansı altında dağıtılmaktadır ve kullanıcılar, lisans koşullarına uymakla yükümlüdür. Yazılımın herhangi bir şekilde değiştirilmesi, dağıtılması veya kullanılması, lisans koşullarına uygun olarak yapılmalıdır. |
91 | | -=========================================================== |
92 | | -""" |
93 | | - |
94 | | -__version__ = "1.0.0" |
95 | | -__author__ = "topluluk veya kisi adi" |
96 | | -__email__ = "posta@posta.com" |
97 | | -__license__ = "MIT" |
98 | | -__status__ = "DEVELOPMENT" # or PRODUCTION, BETA, ALPHA, PROTOTYPE, STABLE, DEPRECATED, MAINTENANCE, EXPERIMENTAL, PREVIEW, ARCHIVED |
99 | | - |
100 | | -__project_name__ = "ornek-proje" |
101 | | -__url__ = "https://website.com/ornek-proje" |
102 | | -__url_github__ = "https://github.com/kullanici/ornek-proje" |
103 | | -__copyright__ = "Telif Hakki (c) 2050 company" |
104 | | -__description__ = "Ornek Proje açıklama" |
105 | | -__date__ = "2024-02-03" # YYYY-MM-DD |
106 | | -__date_modify__ = "2024-02-04" # YYYY-MM-DD |
107 | | -__python_version__ = ">=3.8" |
108 | | -__dependencies__ = { |
109 | | - "python": ">=3.8", |
110 | | - "package1": ">=1.0.0", |
111 | | - "package2": None, # latest or specific version |
112 | | - # ... |
113 | | -} |
114 | | - |
115 | | - |
116 | | -# Projenin ana kodlari buraya gelir |
117 | | -#================================================================================ |
118 | | -#============================ SEPARATER ========================================= |
119 | | - |
120 | | -``` |
121 | | - |
122 | | -<br><br><hr> |
123 | | - |
124 | | -> Connected : |
125 | | -><br> - [website/projects](https://mefamex.com/projects) |
| 1 | +<h1 align="center"> PYTHON DOCSTRING [TR]</h1> |
| 2 | + |
| 3 | +<br> |
| 4 | + |
| 5 | +Docstring yapısı, Python projelerinde kodun amacını, kullanımını ve özelliklerini açıklamak için kullanılır. |
| 6 | + |
| 7 | +Aşağıda, bir Python projesi için örnek bir docstring yapısı verilmiştir. |
| 8 | + |
| 9 | +Bu yapıyı kendi projenize uyarlayabilirsiniz. |
| 10 | + |
| 11 | +> *author:* [mefamex](https://mefamex.com) <br> *last_modify: 2025-07-20* |
| 12 | +
|
| 13 | + |
| 14 | +<hr><br><br> |
| 15 | + |
| 16 | +```python |
| 17 | +# -*- coding: utf-8 -*- |
| 18 | +#!/usr/bin/env python3 |
| 19 | + |
| 20 | +""" |
| 21 | +=========================================================== |
| 22 | + ornek-proje |
| 23 | +=========================================================== |
| 24 | +
|
| 25 | +Description: |
| 26 | + Bu proje, [kısa bir şekilde projenin amacını belirtin] amacıyla geliştirilmiştir. |
| 27 | + Proje, [projedeki ana özellikler ve işlevler listesi] özelliklerine sahiptir. |
| 28 | +
|
| 29 | +Author: |
| 30 | + Ad (posta@posta.com) (https://web_sitesi.com) |
| 31 | +
|
| 32 | +Features: |
| 33 | + - Ozellikleri madde madde veya metin olarak yazabilirsiniz. |
| 34 | +
|
| 35 | +Modules: |
| 36 | + - modul1: [Modul 1 açıklaması] |
| 37 | + - modul2: [Modul 2 açıklaması] |
| 38 | + - ... |
| 39 | +
|
| 40 | +Classes: |
| 41 | + - Sinif1: [Sinif1 açıklaması] |
| 42 | + - Sinif2: [Sinif2 açıklaması] |
| 43 | + - ... |
| 44 | +
|
| 45 | +Functions: |
| 46 | + - fonksiyon1(parametre1, parametre2): [Fonksiyon1 açıklaması] |
| 47 | + - fonksiyon2(parametre1): [Fonksiyon2 açıklaması] |
| 48 | + - ... |
| 49 | +
|
| 50 | +Usage: |
| 51 | + [Projeyi nasıl kullanacağınızı açıklayın. Örnekler ekleyebilirsiniz.] |
| 52 | +
|
| 53 | +Requirements: |
| 54 | + - Python 3.8 veya üstü |
| 55 | + - Dependencies: |
| 56 | + - paket1 (>= sürüm) |
| 57 | + - paket2 (latest) |
| 58 | + - ... |
| 59 | +
|
| 60 | +Installation: |
| 61 | + - Proje klonlama: `git clone [repo adresi]` |
| 62 | + - Gerekli bağımlılıkları kurma: `pip install -r requirements.txt` |
| 63 | +
|
| 64 | +Documentation: |
| 65 | + - Detaylı belgeler için: `README.md` |
| 66 | +
|
| 67 | +License: |
| 68 | + MIT Lisansı (https://opensource.org/licenses/MIT) |
| 69 | +
|
| 70 | +Changelog: |
| 71 | + - 1.0.0 (2024-02-03): İlk sürüm |
| 72 | + - 1.1.0 (2024-02-04): [Yapılan değişiklikler] |
| 73 | + - ... |
| 74 | +
|
| 75 | +Contributors: |
| 76 | + [Projeye katkıda bulunanların adları ve iletişim bilgileri] |
| 77 | +
|
| 78 | +Contact: |
| 79 | + [Projeye ilişkin sorular için e-posta adresi veya diğer iletişim bilgileri] |
| 80 | +
|
| 81 | +Additional Information: |
| 82 | + [Projeye ilişkin ek bilgiler, bağlantılar, belgeler vb.] |
| 83 | +
|
| 84 | +Notes: |
| 85 | + - Bu proje, [proje amacını ve kullanımını açıklayan kısa bir not] içermektedir. |
| 86 | + - Proje, [proje ile ilgili önemli notlar veya uyarılar] içermektedir. |
| 87 | +
|
| 88 | +Disclaimer and Legal Notice: |
| 89 | + Bu yazılım, herhangi bir garanti olmaksızın "olduğu gibi" sağlanmaktadır. Yazar, bu yazılımın kullanımı sonucunda oluşabilecek herhangi bir zarardan sorumlu değildir. Kullanıcılar, yazılımı kendi sorumlulukları altında kullanmalıdır. |
| 90 | + Bu yazılım, açık kaynak lisansı altında dağıtılmaktadır ve kullanıcılar, lisans koşullarına uymakla yükümlüdür. Yazılımın herhangi bir şekilde değiştirilmesi, dağıtılması veya kullanılması, lisans koşullarına uygun olarak yapılmalıdır. |
| 91 | +=========================================================== |
| 92 | +""" |
| 93 | + |
| 94 | +__version__ = "1.0.0" |
| 95 | +__author__ = "topluluk veya kisi adi" |
| 96 | +__email__ = "posta@posta.com" |
| 97 | +__license__ = "MIT" |
| 98 | +__status__ = "DEVELOPMENT" # or PRODUCTION, BETA, ALPHA, PROTOTYPE, STABLE, DEPRECATED, MAINTENANCE, EXPERIMENTAL, PREVIEW, ARCHIVED |
| 99 | + |
| 100 | +__project_name__ = "ornek-proje" |
| 101 | +__url__ = "https://website.com/ornek-proje" |
| 102 | +__url_github__ = "https://github.com/kullanici/ornek-proje" |
| 103 | +__copyright__ = "Telif Hakki (c) 2050 company" |
| 104 | +__description__ = "Ornek Proje açıklama" |
| 105 | +__date__ = "2024-02-03" # YYYY-MM-DD |
| 106 | +__date_modify__ = "2024-02-04" # YYYY-MM-DD |
| 107 | +__python_version__ = ">=3.8" |
| 108 | +__dependencies__ = { |
| 109 | + "python": ">=3.8", |
| 110 | + "package1": ">=1.0.0", |
| 111 | + "package2": None, # latest or specific version |
| 112 | + # ... |
| 113 | +} |
| 114 | + |
| 115 | + |
| 116 | +# Projenin ana kodlari buraya gelir |
| 117 | +#================================================================================ |
| 118 | +#============================ SEPARATER ========================================= |
| 119 | + |
| 120 | +``` |
| 121 | + |
| 122 | +<br><br><hr> |
| 123 | + |
| 124 | +> Connected : |
| 125 | +><br> - [website/projects](https://mefamex.com/projects) |
126 | 126 | ><br> - [Github/Mefamex/python-code-snippets](https://github.com/Mefamex/python-code-snippets) |
0 commit comments