Docchemy 1.0.0

Docchemy

Türkçe

Docchemy bir .NET kütüphanesidir ve yazılım projelerinde otomatik dokümantasyon üretimi sağlamak için geliştirilmiştir. Bu kütüphane, proje analizleri yaparak sınıflar, metodlar ve yorum satırlarından faydalanır ve bu verileri kullanarak OpenAI API ile semantik bir dokümantasyon oluşturur.

Özellikler

• Proje içindeki sınıfları ve metodları analiz eder.
• Otomatik olarak OpenAI API kullanarak açıklamalar oluşturur.
• PDF olarak dökümantasyon oluşturma imkanı sunar.

Kullanılan Model

• Varsayılan model: qwen/qwq-32b:free

• Bu model, OpenAI API üzerinden kullanılır.

• Kullanıcılar modeli değiştirebilir. Aşağıda örnek bir yapılandırma gösterilmektedir:

  builder.Services.AddDocchemyOpenAIBinding(options => {
      options.ApiKey = "YOUR_API_KEY";
      options.ModelId = "NEW_MODEL_ID";  // Burada modeli değiştirebilirsiniz
  });
  

Enable Etme

Docchemy'yi etkinleştirmek için EnableDocumentation özelliğini kullanarak dökümantasyon üretimi için yapılandırma yapabilirsiniz. Bu özellik, kullanıcının dökümantasyon üretim işlemini aktif hale getirmesini sağlar.

• Varsayılan olarak, dökümantasyon üretimi aktif değildir. Aşağıda örnek bir şekilde nasıl etkinleştirileceği gösterilmektedir:

  builder.Services.AddDocchemyOpenAIBinding(options => {
      options.ApiKey = "YOUR_API_KEY";
      options.EnableDocumentation = true;  // Burada dökümantasyon oluşturma özelliğini etkinleştiriyoruz
  });
  

Kurulum

1. NuGet üzerinden yükleme:

   dotnet add package Docchemy
   

2. Yükleme Sonrası Yapılandırma: Projeye AddDocchemyOpenAIBinding methodunu ekleyerek OpenAI API anahtarını ve isteğe bağlı ayarları yapılandırabilirsiniz.

   builder.Services.AddDocchemyOpenAIBinding(options => options.ApiKey = "YOUR_API_KEY");
   

Kullanım

Dokümantasyon üretmek için aşağıdaki gibi yapılandırmanızı yapabilirsiniz:

// Belge oluşturulması işlemi başlatılır
await builder.Services.AddDocchemyOpenAIBinding(options => options.ApiKey = "YOUR_API_KEY");

English

Docchemy is a .NET library designed to generate automatic documentation for software projects. This library analyzes your project and uses class, method, and comment data to create semantic documentation through the OpenAI API.

Features

• Analyzes classes and methods within your project.
• Automatically generates explanations using the OpenAI API.
• Allows generating documentation in PDF format.

Default Model

• The default model is: qwen/qwq-32b:free

• This model is used via the OpenAI API.

• Users can change the model. Here's an example of how to configure it:

  builder.Services.AddDocchemyOpenAIBinding(options => {
      options.ApiKey = "YOUR_API_KEY";
      options.ModelId = "NEW_MODEL_ID";  // You can change the model here
  });
  

Enabling Documentation

By default, documentation generation is disabled. To enable it, you need to configure the EnableDocumentation option as shown below. This allows users to activate the documentation generation process.

• By setting EnableDocumentation to true, you enable the documentation creation process:

  builder.Services.AddDocchemyOpenAIBinding(options => {
      options.ApiKey = "YOUR_API_KEY";
      options.EnableDocumentation = true;  // Enable documentation generation
  });
  

Installation

1. Install via NuGet:

   dotnet add package Docchemy
   

2. Configuration After Installation: You can configure the OpenAI API key and other optional settings by adding the AddDocchemyOpenAIBinding method to your project.

   builder.Services.AddDocchemyOpenAIBinding(options => options.ApiKey = "YOUR_API_KEY");
   

Usage

To start generating documentation, you can configure it like this:

// Documentation generation process starts
await builder.Services.AddDocchemyOpenAIBinding(options => options.ApiKey = "YOUR_API_KEY");

Diğer Notlar:

• OpenAI API anahtarınız gereklidir. API anahtarınızı OpenAI üzerinden alabilirsiniz. Ücretsiz modelleri OpenRouter, HuggingFace üzerinden bulup entegre edebilirsiniz.
• Bu kütüphane, proje derlenirken otomatik olarak çalışarak dokümantasyon üretir.
• PDF dökümantasyonu oluşturma özelliği, projede DinkToPdf gibi bir kütüphane ile entegre edilmiştir.