17 مستودعات
Annotates logic with human-readable text that is ignored by the compiler but preserved for developers.
Distinguishing note: None of the candidates relate to language-level documentation comments.
Explore 17 awesome GitHub repositories matching programming languages & runtimes · Source Code Documentation. Refine with filters or upvote what's useful.
Crystal is a statically typed, compiled programming language designed for high performance and memory safety. It leverages an LLVM-based compiler to translate source code into optimized machine-executable binaries, while its type-inference-based static analysis enforces strict safety rules during the build process. The language distinguishes itself through a fiber-based concurrent runtime that manages lightweight execution units for asynchronous input and output without blocking the main process. It also features a powerful compile-time macro system that allows for the inspection and transfor
Preserves developer-focused documentation within the source code.
This project is an educational resource designed for learning the Python programming language. It serves as a tutorial repository and programming guide, providing a collection of annotated scripts, code examples, and cheatsheets to help users master syntax and core fundamentals. The resource focuses on moving from basic language syntax to advanced implementation, with a particular emphasis on object-oriented programming, the use of the Python standard library, and scripting automation for business workflows. The content covers a broad range of programming capabilities, including control flow
Shows how to use single-line comments and docstrings to provide internal documentation within source files.
The Rust Programming Language Book is the official technical guide and educational resource for the Rust language. It provides a comprehensive walkthrough of the language's design, focusing on its core identity as a systems programming language that enforces memory safety and high-performance execution without the need for a garbage collector. The project is distinguished by its focus on ownership, borrowing, and lifetime tracking, which allow the compiler to verify memory safety and thread safety at compile time. It covers the language's unique approach to zero-cost abstractions, including t
Supports human-readable documentation comments ignored by the compiler.
Showdoc is a technical documentation platform and knowledge management system designed to centralize project specifications, internal manuals, and technical guides. Built as a PHP web application, it provides a collaborative environment for teams to organize and share information across software development organizations. The platform distinguishes itself through its ability to automate documentation workflows by parsing source code comments and synchronizing technical records with the current state of a codebase. It also features specialized tools for managing RESTful API documentation and g
The system scans source code files for specific comment patterns to extract and synchronize technical documentation with the codebase.
This repository is a collection of solved algorithmic problems and data structure exercises designed for technical interview preparation. It serves as a polyglot reference implementation, providing a set of solved exercises based on a standard textbook to help candidates master the logic and complexity analysis required for coding tests. The project implements the same algorithmic logic across multiple programming languages to demonstrate platform-independent problem solving. This polyglot approach allows for the comparison of implementations across different tech stacks to highlight recurrin
Embeds algorithmic complexity and logic explanations directly within the source code comments.
A fast, helpful, and open-source document parser
An open-source document parser that extracts text, tables, and layout from PDFs and office files into Markdown or JSON.
TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into structured API reference websites or data files. It functions as a static site generator that converts code symbols into a searchable web interface. The project is an extensible framework, allowing users to modify the documentation process and generator logic through a programmable plugin system and custom themes. Its capabilities include API reference generation, source code parsing, and documentation coverage validation to ensure exported members are properly described. It support
Transforms source code into searchable documentation by analyzing entry points and compiler settings.
koro1FileHeader هو إضافة لـ VSCode مصممة لإنشاء وتحديث كتل التعليقات الموحدة تلقائياً في أعلى ملفات المصدر. تعمل كمدير لبيانات تعريف الملف وموثق كود آلي يتتبع التأليف، وأوقات التعديل، ومسارات الملفات مباشرة داخل الكود عند الحفظ. تقوم الأداة بمزامنة أسماء المؤلفين وعناوين البريد الإلكتروني من إعدادات Git المحلية لملء حقول الرأس. كما تتميز بمزخرف تعليقات كود المصدر القادر على إدراج فن تعليقات زخرفي وأنماط مرئية لتنظيم أقسام الكود. تغطي الإضافة نطاقاً واسعاً من القدرات بما في ذلك إنشاء docstring للدالة تلقائياً من خلال استخراج المعلمات، والتخصيص القائم على القوالب لإشعارات حقوق النشر والتراخيص، وتعيين المحددات الخاصة باللغة. تتضمن آليات تصفية لاستبعاد أدلة أو امتدادات ملفات معينة وتستخدم اكتشاف التغيير للتراجع عن تحديثات البيانات التعريفية التافهة، مما يمنع التزامات التحكم في الإصدار الزائدة.
Automatically generates and updates standardized file headers and function comments to maintain consistent documentation across a codebase.
Documentation.js is a multi-purpose documentation tool that parses JSDoc annotations from JavaScript and TypeScript source files to generate formatted API documentation. It functions as both a documentation generator and a JSDoc linter, scanning source code for non-standard or incorrect annotations and returning human-readable warnings to enforce documentation quality. The tool operates through a pipeline-based architecture that parses JSDoc comments into an abstract syntax tree, validates annotations against style and correctness rules, and outputs documentation through interchangeable plugi
Generates documentation from TypeScript source files by parsing JSDoc annotations.
هذا المشروع عبارة عن مجموعة شاملة من مواد تعليم برمجة Python، بما في ذلك البرامج التعليمية، والتمارين، وعينات الكود المنسقة. يعمل كمنهج تعليمي ومجموعة أدوات هندسة برمجيات، باستخدام Jupyter Notebooks لدمج الكود القابل للتنفيذ مع نص تعليمي وصفي. يوفر المستودع أدلة تنفيذ عملية لبناء تطبيقات نماذج لغوية كبيرة، مثل أنظمة التوليد المعزز بالاسترجاع، ووكلاء الذكاء الاصطناعي ذوي الحالة، وسير عمل التعلم الآلي. يتميز بتقديم نهج منظم لسير عمل الترميز الوكيل، وتغطية تقطير نافذة السياق، وتوجيه النموذج المستقل عن المزود، والمخرجات المهيكلة المفروضة بالمخطط. تغطي المواد مجموعة واسعة من قدرات هندسة البرمجيات، بما في ذلك البرمجة غير المتزامنة مع طوابير المهام الموزعة، وتطوير تطبيقات الويب مع REST APIs، وسير عمل تحليل البيانات. كما يتضمن موارد لإتقان التصميم الموجه للكائنات، وتنفيذ خطوط أنابيب CI/CD، وتطبيق معايير التنسيق والتدقيق المهنية.
Teaches how to annotate logic with docstrings and comments to improve code readability.
c3c is the compiler for the C3 programming language, transforming source code into executable binaries, static libraries, or dynamic libraries using an LLVM backend. It implements a system based on result-based error handling, scoped memory pooling, and a semantic macro system. The compiler provides first-class support for hardware-backed SIMD vectors that map directly to processor instructions and enables runtime polymorphism through interface-based dynamic dispatch. The project covers a broad set of low-level capabilities, including manual and pooled memory management, inline assembly inte
Embeds descriptive text and formal contracts directly into the source code using special delimiters.
r4ds هو منهج لعلوم البيانات ومورد تعليمي مصمم لإتقان لغة البرمجة R. يوفر مسار تعلم منظماً للعملية الشاملة لاستيراد البيانات، وتنظيمها، وتحويلها، وتصورها. يركز المشروع على دليل علوم البيانات القابل للتكرار ومنهج شامل لمعالجة البيانات. يتضمن دروساً تعليمية متخصصة حول قواعد الرسومات لتصور البيانات الطبقي والمنشورات التقنية التي تم إنشاؤها باستخدام Quarto والتي تمزج بين الكود القابل للتنفيذ والنثر السردي. تغطي المادة مجموعة واسعة من القدرات التحليلية، بما في ذلك استيعاب البيانات من مصادر متنوعة، وربط البيانات العلائقية، وإدارة المتغيرات الفئوية. كما تتناول تنظيف البيانات، والنمذجة الرياضية، وإنشاء تقارير وعروض تقديمية احترافية متعددة التنسيقات. يركز المنهج على التطبيق العملي للبرمجة الوظيفية ومبادئ البيانات المرتبة (Tidy data) لإنشاء تحليلات شفافة وقابلة للتكرار.
Teaches how to annotate code logic with human-readable text for better developer understanding.
Nerdcommenter هو إضافة تعليق لـ Vim ومعالج نصوص مصمم لأتمتة إدراج وإزالة وتنسيق تعليقات الكود الخاصة باللغة. يعمل كأداة لتبديل علامات التعليق ومحاذاة كتل التعليق لتحسين تنظيم الكود. توفر الأداة قدرات لتبديل حالة التعليق وتبديل المحددات، مما يسمح للمستخدمين بإضافة أو إزالة العلامات من أسطر مفردة أو كتل محددة من النص. تتضمن ميزات لتنسيق كتلة التعليق لضمان الاتساق البصري والقدرة على تعليق الكود لتعطيل التنفيذ. تغطي الإضافة مجموعة واسعة من التطبيقات الوظيفية، بما في ذلك توثيق الكود المصدري وتصحيح منطق الكود. تعمل على تحسين سير عمل Vim من خلال تقليل ضغطات المفاتيح المطلوبة لإدارة محددات التعليق عبر لغات برمجة مختلفة.
Facilitates the creation of clean, readable documentation blocks within the source code.
TSDoc هو معيار توثيق ومواصفات لكتابة التعليقات المهيكلة في كود TypeScript. يوفر نظاماً قابلاً للنقل لتعريف البيانات الوصفية، والوسوم، والمراجع التبادلية داخل الكود المصدري لضمان التحليل والعرض المتسق عبر الأدوات المختلفة. يتضمن المشروع محلل تعليقات توثيق يقوم بتحويل التعليقات إلى شجرة بناء جملة مهيكلة، ومدققاً يفرض اتساق بناء الجملة. يسمح بتعريف وسوم توثيق مخصصة من خلال ملفات تكوين خارجية ويدعم أوضاع التحقق من بناء الجملة المتعددة للمساعدة في الامتثال للمواصفات. تغطي المواصفات مجموعة واسعة من احتياجات توثيق API، بما في ذلك تحديد مراحل الإصدار، والاستقرار، والإهمال. تدعم تفصيل معاملات الدوال، وقيم الإرجاع، وأنواع الاستثناءات، بالإضافة إلى إدارة الرؤية الداخلية، والوراثة، والمراجع التبادلية بين الإعلانات.
Establishes a standardized way to write documentation comments for TypeScript code across different tools.
Textract هو أداة لاستخراج النصوص من تنسيقات متعددة ومحلل بيانات. يوفر واجهة موحدة لاستخراج النصوص العادية من مجموعة متنوعة من المصادر، بما في ذلك المستندات والصور والملفات الصوتية. يعمل النظام كمحلل لمحتوى المستندات لملفات PDF وجداول البيانات، ومستخرج للنصوص من الصور باستخدام التعرف الضوئي على الحروف (OCR)، ومحول للكلام إلى نص للتسجيلات الصوتية.
Maps PDFs and spreadsheets to a common internal representation for consistent text retrieval.
This project is a collection of technical breakdowns and annotated source code providing a detailed analysis of the Underscore JavaScript utility library. It serves as source code documentation that maps high-level functional logic to specific lines of code through technical commentary. The analysis focuses on JavaScript pattern study and legacy code documentation. It examines historical language constraints and browser compatibility strategies to explain the evolution of utility patterns and the reasoning behind specific architectural choices in older library versions. The project covers se
Maps high-level functional logic to specific lines of code through detailed technical commentary and modular breakdowns.
Tinymist is a comprehensive suite of tools for Typst document authoring, serving as a language server, document compiler, and project manager. It provides a standardized language service via the Language Server Protocol to enable editor features such as autocompletion, navigation, and semantic highlighting. The project distinguishes itself by integrating a TCP-based live preview server for real-time visual rendering and an advanced static analysis tool that utilizes abstract syntax trees and bidirectional type checking. It also includes a project management system capable of handling multi-fi
Extracts human-readable descriptions and type annotations from source comments for hover display.