Docstring yapısı, Python projelerinde kodun amacını, kullanımını ve özelliklerini açıklamak için kullanılır.
Aşağıda, bir Python projesi için örnek bir docstring yapısı verilmiştir.
Bu yapıyı kendi projenize uyarlayabilirsiniz.
author: mefamex
last_modify: 2025-07-20
# -*- coding: utf-8 -*-
#!/usr/bin/env python3
"""
===========================================================
ornek-proje
===========================================================
Description:
Bu proje, [kısa bir şekilde projenin amacını belirtin] amacıyla geliştirilmiştir.
Proje, [projedeki ana özellikler ve işlevler listesi] özelliklerine sahiptir.
Author:
Ad (posta@posta.com) (https://web_sitesi.com)
Features:
- Ozellikleri madde madde veya metin olarak yazabilirsiniz.
Modules:
- modul1: [Modul 1 açıklaması]
- modul2: [Modul 2 açıklaması]
- ...
Classes:
- Sinif1: [Sinif1 açıklaması]
- Sinif2: [Sinif2 açıklaması]
- ...
Functions:
- fonksiyon1(parametre1, parametre2): [Fonksiyon1 açıklaması]
- fonksiyon2(parametre1): [Fonksiyon2 açıklaması]
- ...
Usage:
[Projeyi nasıl kullanacağınızı açıklayın. Örnekler ekleyebilirsiniz.]
Requirements:
- Python 3.8 veya üstü
- Dependencies:
- paket1 (>= sürüm)
- paket2 (latest)
- ...
Installation:
- Proje klonlama: `git clone [repo adresi]`
- Gerekli bağımlılıkları kurma: `pip install -r requirements.txt`
Documentation:
- Detaylı belgeler için: `README.md`
License:
MIT Lisansı (https://opensource.org/licenses/MIT)
Changelog:
- 1.0.0 (2024-02-03): İlk sürüm
- 1.1.0 (2024-02-04): [Yapılan değişiklikler]
- ...
Contributors:
[Projeye katkıda bulunanların adları ve iletişim bilgileri]
Contact:
[Projeye ilişkin sorular için e-posta adresi veya diğer iletişim bilgileri]
Additional Information:
[Projeye ilişkin ek bilgiler, bağlantılar, belgeler vb.]
Notes:
- Bu proje, [proje amacını ve kullanımını açıklayan kısa bir not] içermektedir.
- Proje, [proje ile ilgili önemli notlar veya uyarılar] içermektedir.
Disclaimer and Legal Notice:
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.
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.
===========================================================
"""
__version__ = "1.0.0"
__author__ = "topluluk veya kisi adi"
__email__ = "posta@posta.com"
__license__ = "MIT"
__status__ = "DEVELOPMENT" # or PRODUCTION, BETA, ALPHA, PROTOTYPE, STABLE, DEPRECATED, MAINTENANCE, EXPERIMENTAL, PREVIEW, ARCHIVED
__project_name__ = "ornek-proje"
__url__ = "https://website.com/ornek-proje"
__url_github__ = "https://github.com/kullanici/ornek-proje"
__copyright__ = "Telif Hakki (c) 2050 company"
__description__ = "Ornek Proje açıklama"
__date__ = "2024-02-03" # YYYY-MM-DD
__date_modify__ = "2024-02-04" # YYYY-MM-DD
__python_version__ = ">=3.8"
__dependencies__ = {
"python": ">=3.8",
"package1": ">=1.0.0",
"package2": None, # latest or specific version
# ...
}
# Projenin ana kodlari buraya gelir
#================================================================================
#============================ SEPARATER =========================================Connected :
- website/projects
- Github/Mefamex/python-code-snippets