Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pouyakary/coding-standards

Source code for the https://kcs.library.kary.us
https://github.com/pouyakary/coding-standards

book coding-standard gitbook kary-comments kary-library kary-righteous library standard

Last synced: about 1 month ago
JSON representation

Source code for the https://kcs.library.kary.us

Awesome Lists containing this project

README 

        
# Overview of Kary Coding Standards



{% hint style="danger" %}

You are reading a draft edition of this document. If you found any errors, please report them to [[email protected]](mailto:[email protected])

{% endhint %}



![](.gitbook/assets/kary-coding-standards-logo.png)



## Philosophy



Code is something very pretty. It's a form of art and engineering. Yet, we write codes that look messy and horrible. I believe that codes must look nice and beautiful. When you read them they must show how carefully they were written and how much love was put into writing them. Code must look like candy and art. This standard is one—in a [series of attempts](https://writings.kary.us/2017/05/16/my-journey-to-clean-code/)—to push the state of beauty and functionality in code. 



![](.gitbook/assets/screen_shot_1396-12-11_at_2.21.50_am.png)



## Core Beliefs



1. Programmers are no robots, they have hearts and they deserve beauty.

2. Code is a form of art thus it deserves to be written beautifully.

3. Code is a Piece of Writing and therefore must have layout and design principles involved in it.

4. Writing something with care results in higher quality.



Kary Coding Standards is a body of works that contains many standards, designs, beliefs, libraries, languages, and tools to achieve a harmonious state-of-the-art coding standard that respects the four mentioned believes. It is itself also a member of a much bigger umbrella project 



{% page-ref page="karys-coding-umbrella.md" %}



## Structure of This Document



This document is the documentation and specification of Kary Coding Standards and therefore separated into 3 parts.



### Language Standards



These are the specifications of the coding standard for some general languages—starting with web languages for their mass use.



{% page-ref page="languages/javascript.md" %}



{% page-ref page="languages/css.md" %}



### Software Tools



The Kary Coding Standards are no easy standards to implement. They put functionality and beauty first and therefore typing efficiency is not a priority. That is because, the standards have their own set of accompanying software that facilitate the heavy formatting and generation of complex statements \(such as Kary Comments\). The documentation for these tools are also included within this document to make it a coherent and self-contained standard.



{% page-ref page="tools/righteous.md" %}



{% page-ref page="tools/comment-v.md" %}



### Kary Comments



Kary Comments are the foundations of this standard and while most languages contain their own rules and specificities, these are shared widely across any language that implements Kary Coding Standard. For better understanding of these comments, there is a series of short articles explaining them.



{% page-ref page="comments/introduction.md" %}



{% page-ref page="comments/sectioning.md" %}



{% page-ref page="comments/reference.md" %}