Skip to content
DevMeme
3862 of 7590
Apple Comments With Architecture Diagrams
Documentation Post #4205 · source on Telegram

Apple Comments With Architecture Diagrams

Description

A dark-theme code editor shows Swift source with line numbers, beginning with `import Foundation`, `import Markdown`, and `import SymbolKit`. A long comment explains "Link resolution works in two parts" for DocC, describing documentation bundles, external references, resolvers, and summaries of linkable elements. The middle of the file contains a large ASCII flow diagram labeled with pieces such as "DocC," "Backend endpoint," "DocumentationContext Register bundle," "DocumentationContext Resolve links," "Out-of-process resolver," "Request information from a server," "Other sources," and "ConvertAction write linkable entities." Below the diagram, the code defines `public struct LinkDestinationSummary: Codable, Equatable` with documented properties including `kind`, `language`, `path`, `referenceURL`, `title`, `abstract`, and `availableLanguages`, turning a comment block into a miniature architecture document.

Categories

Documentation CodeQuality Apple OpenSource DesignPatterns Architecture

Common Tags

CodeComments Documentation TechnicalDocumentation DocumentationQuality Swift Apple CodeDocumentationTools OpenSource Ascii CodeReadability Markdown CodeMaintainability FoundationFramework SoftwareArchitecturePatterns DiagrammingTools

Comments

14
Anonymous ★ Top Pick Apple looked at `// TODO: explain this later` and shipped a small RFC inside the comment block instead.
  1. Anonymous ★ Top Pick

    Apple looked at `// TODO: explain this later` and shipped a small RFC inside the comment block instead.

  2. @saidov 4y

    That’s impressive

  3. dev_meme 4y

    Asciiflow.com For the flowchart (Or monodraw, as suggested below)

    1. @feskow 4y

      Thanks, that's better than vim boxes o:

  4. @dsmagikswsa 4y

    Tool: https://monodraw.helftone.com

    1. @jor_ban 4y

      God bless you

  5. @saniel42 4y

    Unity Input System moment

  6. @TERASKULL 4y

    Apple has open source stuff? wow

    1. @QutePoet 4y

      Print system for Linux CUPS for example. It's the only one that works normally.

  7. dev_meme 4y

    Fuck programming, i'm going straight to McDonald's

    1. @dsmagikswsa 4y

      They hire programmers though.

      1. dev_meme 4y

        Good news

        1. @dsmagikswsa 4y

          https://www.reddit.com/r/ProgrammerHumor/comments/sme74n/mcds_playing_hardball_do_you_think_theyd_at_least/ Not sure, they pay you as their standard as well.

          1. dev_meme 4y

            Lol

More like this

More like this in Documentation →
Documentation CodeComments Documentation
Comment Typos: Embarrassing Before AI, Load-Bearing After AI

Comment Typos: Embarrassing Before AI, Load-Bearing After AI

AI ML
Self-Documenting Code Taken to Absurd Extremes with Function Name as Comment

Self-Documenting Code Taken to Absurd Extremes with Function Name as Comment

CodeQuality
Documentation Motivation Shifts From Humans to AI Agents

Documentation Motivation Shifts From Humans to AI Agents

Documentation
Use J and K for navigation