192 lines
4.2 KiB
Markdown
192 lines
4.2 KiB
Markdown
# Issue #003: Charter和CNNL语法文档创建
|
||
|
||
**工单编号**: ISSUE-003
|
||
**标题**: Charter和CNNL语法文档创建
|
||
**优先级**: 🟡 中
|
||
**状态**: ✅ 已完成
|
||
**创建日期**: 2026-02-20
|
||
**完成日期**: 2026-02-20
|
||
**负责人**: NAC技术团队
|
||
**依赖工单**: #002
|
||
|
||
---
|
||
|
||
## 一、工单背景
|
||
|
||
在模块验证过程中发现Charter和CNNL编译器缺少完整的语法文档，导致开发者无法正确使用这两个编译器。需要创建详细的语法指南和示例代码。
|
||
|
||
---
|
||
|
||
## 二、执行内容
|
||
|
||
### 2.1 Charter语言语法指南
|
||
|
||
创建完整的Charter语言文档，包括：
|
||
|
||
**基础内容**：
|
||
- Charter语言简介和设计原则
|
||
- 与Solidity的区别对比
|
||
- 基本语法结构
|
||
- 数据类型系统（U256, String, Address, Hash等）
|
||
- 函数定义和修饰符
|
||
- 事件系统
|
||
|
||
**高级内容**：
|
||
- 完整的ERC-20风格代币合约示例
|
||
- RWA资产合约示例
|
||
- 与CNNL宪法集成
|
||
- 编译和部署指南
|
||
- 内置函数和全局变量
|
||
- 最佳实践和安全建议
|
||
|
||
**关键差异说明**：
|
||
- 地址类型：32字节（非20字节）
|
||
- 哈希算法：SHA3-384（非Keccak-256）
|
||
- 类型命名：String（非string）
|
||
- 虚拟机：NVM（非EVM）
|
||
|
||
### 2.2 CNNL语法指南
|
||
|
||
创建完整的CNNL宪政神经网络语言文档，包括：
|
||
|
||
**基础内容**：
|
||
- CNNL简介和核心概念
|
||
- 宪法声明语法
|
||
- 条款（Clause）结构
|
||
- 数据类型和运算符
|
||
- 内置函数
|
||
|
||
**高级内容**：
|
||
- 基础宪法示例
|
||
- RWA合规宪法示例
|
||
- 治理宪法示例
|
||
- 形式化验证支持
|
||
- 与Charter集成机制
|
||
- 编译和部署指南
|
||
|
||
**核心特性**：
|
||
- 宪法优先原则
|
||
- 神经网络式规则依赖
|
||
- 动态演化机制
|
||
- 条款优先级系统
|
||
|
||
---
|
||
|
||
## 三、交付物
|
||
|
||
### 3.1 文档文件
|
||
|
||
- ✅ `Charter_Language_Syntax_Guide.md` - Charter完整语法指南（约3000行）
|
||
- ✅ `CNNL_Language_Syntax_Guide.md` - CNNL完整语法指南（约2500行）
|
||
|
||
### 3.2 示例代码
|
||
|
||
**Charter示例**：
|
||
- 简单代币合约（SimpleToken）
|
||
- RWA资产合约（RealWorldAsset）
|
||
- 包含构造函数、状态变量、事件、函数等完整结构
|
||
|
||
**CNNL示例**：
|
||
- 基础规则宪法（NAC_Basic_Rules）
|
||
- RWA合规宪法（RWA_Compliance）
|
||
- 治理宪法（NAC_Governance）
|
||
- 形式化验证示例
|
||
|
||
---
|
||
|
||
## 四、文档特点
|
||
|
||
### 4.1 结构化组织
|
||
- 从基础到高级，循序渐进
|
||
- 清晰的章节划分
|
||
- 详细的目录索引
|
||
|
||
### 4.2 实用性强
|
||
- 大量代码示例
|
||
- 常见错误对比
|
||
- 最佳实践建议
|
||
- 完整的编译命令
|
||
|
||
### 4.3 易于理解
|
||
- 与熟悉的技术对比（Solidity、HTML）
|
||
- 表格化的对比说明
|
||
- 详细的注释
|
||
- 清晰的错误示例
|
||
|
||
---
|
||
|
||
## 五、验证清单
|
||
|
||
- [x] Charter语言简介
|
||
- [x] Charter基本语法
|
||
- [x] Charter数据类型
|
||
- [x] Charter完整示例
|
||
- [x] Charter编译指南
|
||
- [x] Charter最佳实践
|
||
- [x] CNNL语言简介
|
||
- [x] CNNL条款语法
|
||
- [x] CNNL完整示例
|
||
- [x] CNNL形式化验证
|
||
- [x] CNNL编译指南
|
||
- [x] 文档格式检查
|
||
- [x] 代码示例测试
|
||
|
||
---
|
||
|
||
## 六、使用指南
|
||
|
||
### 6.1 开发者使用流程
|
||
|
||
1. 阅读对应语言的语法指南
|
||
2. 参考示例代码
|
||
3. 编写自己的合约/宪法
|
||
4. 使用编译器编译
|
||
5. 部署到NAC主网
|
||
|
||
### 6.2 文档位置
|
||
|
||
- 本地路径：`/home/ubuntu/Charter_Language_Syntax_Guide.md`
|
||
- 本地路径：`/home/ubuntu/CNNL_Language_Syntax_Guide.md`
|
||
- 将上传到：`/opt/nac/docs/standards/`
|
||
- 将发布到：NAC官方文档站
|
||
|
||
---
|
||
|
||
## 七、后续工作
|
||
|
||
### 7.1 短期（1周内）
|
||
- 将文档上传到服务器
|
||
- 发布到官方文档站
|
||
- 创建在线示例编辑器
|
||
|
||
### 7.2 中期（1个月内）
|
||
- 根据社区反馈优化文档
|
||
- 添加更多示例
|
||
- 创建视频教程
|
||
- 翻译成英文版本
|
||
|
||
### 7.3 长期（3个月内）
|
||
- 开发IDE插件（语法高亮、自动补全）
|
||
- 建立示例代码库
|
||
- 举办开发者培训
|
||
- 认证开发者计划
|
||
|
||
---
|
||
|
||
## 八、相关工单
|
||
|
||
- #002: 模块验证（前置工单）
|
||
- #007: Charter编译器功能增强（后续工单）
|
||
- #008: CNNL编译器功能增强（后续工单）
|
||
- #006: Git文档中心建设（并行工单）
|
||
|
||
---
|
||
|
||
**工单状态**: ✅ 已完成
|
||
**审核人**: 待审核
|
||
**归档日期**: 2026-02-20
|
||
|
||
---
|
||
|
||
*本工单解决了Charter和CNNL编译器缺少文档的问题，为开发者提供了完整的语法指南。*
|