{"id":20933641,"url":"https://github.com/greatislander/laser-eye-comments","last_synced_at":"2026-04-20T21:34:13.522Z","repository":{"id":77856326,"uuid":"292600825","full_name":"greatislander/laser-eye-comments","owner":"greatislander","description":"Content for a lightning talk on code comments.","archived":false,"fork":false,"pushed_at":"2020-09-03T15:39:22.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-12-30T02:42:49.732Z","etag":null,"topics":["comments","jsdoc","phpdocumentor","restructuredtext"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greatislander.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-03T14:56:57.000Z","updated_at":"2020-09-10T06:08:37.000Z","dependencies_parsed_at":"2023-04-11T11:01:00.431Z","dependency_job_id":null,"html_url":"https://github.com/greatislander/laser-eye-comments","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/greatislander/laser-eye-comments","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greatislander%2Flaser-eye-comments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greatislander%2Flaser-eye-comments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greatislander%2Flaser-eye-comments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greatislander%2Flaser-eye-comments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greatislander","download_url":"https://codeload.github.com/greatislander/laser-eye-comments/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greatislander%2Flaser-eye-comments/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32067613,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T21:26:33.338Z","status":"ssl_error","status_checked_at":"2026-04-20T21:26:22.081Z","response_time":94,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comments","jsdoc","phpdocumentor","restructuredtext"],"created_at":"2024-11-18T21:56:03.188Z","updated_at":"2026-04-20T21:34:13.506Z","avatar_url":"https://github.com/greatislander.png","language":"Python","readme":"# Code Comments\n\n\u003e 4. The public API is commented. ([source](https://wiki.fluidproject.org/display/fluid/Laser+Eye+Checklist))\n\n## What\n\nGenerally code comments take one of three forms:\n\n1. File-level comments, which provide information about the contents of a file.\n2. Block-level comments (sometimes known as docblocks), which document the API or usage of a specific function, method or class.\n3. Line-level comments, which provide inline documention of a function or method's internal operations.\n\n## Why\n\n\u003e Code can only tell you _how_ the program works; comments can tell you _why_ it works. ([source](https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/))\n\nFile-level comments help provide a sense of the overall structure of the project (the more complex the project, the more helpful they are). Block-level comments provide documentation for the API (for example, they often tell what input is required and what output is expected). Line-level comments can clarify complex code within a function or method, provide contextual references to external resources, and document areas where future improvements may be needed.\n\nCode comments written according to a specification (e.g. JSDoc, phpDocumentor, or one of various Python docstring formats) can be used to automatically generate HTML or other documentation for an application.\n\n## How\n\n- [JavaScript](https://github.com/greatislander/laser-eye-comments/tree/dev/js/)\n- [PHP](https://github.com/greatislander/laser-eye-comments/tree/dev/php/)\n- [Python](https://github.com/greatislander/laser-eye-comments/tree/dev/python/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreatislander%2Flaser-eye-comments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreatislander%2Flaser-eye-comments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreatislander%2Flaser-eye-comments/lists"}