Cangjie Programming Language Documentation

查看中文

Cangjie programming language is a general programming language for full-scene application development, balancing development efficiency and runtime performance, and providing a good programming experience.

This repository stores the developer documentation for Cangjie programming language. Welcome to read the documentation, participate in the Cangjie developer documentation open-source project, and jointly improve the developer documentation.

Introduction

Cangjie provides the following developer documentation:

  • Cangjie Programming Language Development Guide: Introduces Cangjie syntax, compilation, and build content.
  • Cangjie Programming Language Tools Usage Guide: Introduces the tools provided by Cangjie, including the project management tool cjpm, debugging tool cjdb, formatting tool cjfmt , hyper-language extension HLE and the language server tool LSP.
  • Cangjie Programming Language Standard Library API: Provides a reference for the Cangjie standard library API, including API functions, parameters, return values, examples, etc. Please obtain this document from the cangjie_runtime repository.
  • Cangjie Programming Language Extension Library API: Provides a reference for the Cangjie extension library API, including API functions, parameters, return values, examples, etc. Please obtain this document from the cangjie_stdx repository.

Directory

The directory structure of this repository is as follows:

.
└── docs
    ├── cmd-tools    # This directory stores the Cangjie programming language command-line tool usage guide
    └── dev-guide    # This directory stores the Cangjie programming language development guide

Document Versions and Branch Descriptions

This section explains the purpose of each branch in the cangjie_docs repository.

Note:

Branches may be added or removed depending on version releases. Please refer to actual query results.

Main Branch

main: The default main branch, integrating stable feature documentation.

Release and Supporting Branches

  • release/1.1: Cangjie 1.1.0 STS release branch. Click here for version details.
  • release/1.0: Cangjie 1.0.x LTS release branch. Click here for version details.

OpenHarmony Supporting Branch

release/OpenHarmony-release-6.0.2: Cangjie documentation supporting OpenHarmony 6.0.2.

License

Please refer to the License for the Cangjie developer documentation license.

Contribution

You are welcome to contribute. We encourage developers to participate in documentation feedback and contributions in various ways.

You can evaluate existing documentation, make simple changes, provide feedback on documentation quality issues, contribute your original content, etc. Refer to CONTRIBUTING.