diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8b9f78a --- /dev/null +++ b/.gitignore @@ -0,0 +1,57 @@ +# 通用 +*.log +*.tmp +*.temp +.DS_Store +Thumbs.db + +# 编辑器 / IDE +.vscode/ +.idea/ +*.swp +*.swo +*~ +.project +.classpath +.settings/ + +# 依赖目录 +node_modules/ +vendor/ +venv/ +env/ +.env + +# 构建输出 +dist/ +build/ +out/ +target/ +*.egg-info/ +__pycache__/ +*.pyc +*.pyo +*.class +*.o +*.so +*.dll +*.exe + +# 测试覆盖率 +coverage/ +.coverage +*.cover +.pytest_cache/ +.nyc_output/ + +# 包管理器 +package-lock.json +yarn.lock +Pipfile.lock +Gemfile.lock +composer.lock + +# 临时文件 +*.bak +*.backup +*.cache diff --git a/README.md b/README.md index a7c4db8..f9e8677 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ -# monkeycode-practise -monkeycode 练习项目 +# MonkeyCode 练习项目 + +这是一个空项目,用于 MonkeyCode 开发平台的用户练手。 + +## 项目简介 + +本项目为 MonkeyCode 开发平台提供一个练习环境,用户可以在此项目中: +- 练习代码编写 +- 测试各种开发工具 +- 学习和实验新技术 +- 进行代码重构练习 + +## 项目结构 + +``` +monkeycode-practise/ +├── src/ # 源代码目录 +├── tests/ # 测试代码目录 +├── docs/ # 文档目录 +└── examples/ # 示例代码目录 +``` + +## 使用说明 + +1. 在 `src/` 目录下创建你的源代码文件 +2. 在 `tests/` 目录下编写对应的测试代码 +3. 在 `docs/` 目录下添加项目文档 +4. 参考 `examples/` 目录中的示例代码学习 + +## 贡献指南 + +欢迎所有用户使用本项目进行练习和学习。这是一个开放的练习环境,请随意创建、修改和实验。 + +## 许可证 + +本项目仅用于学习和练习目的。 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..6bfff90 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,13 @@ +# 文档目录 + +在此目录下放置项目文档。 + +## 内容建议 + +- 设计文档 +- API 文档 +- 使用指南 +- 架构说明 +- 学习笔记 + +练习编写清晰的技术文档! diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..e3c53b4 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,12 @@ +# 示例代码目录 + +在此目录下放置示例代码和学习材料。 + +## 用途 + +- 保存有用的代码片段 +- 创建学习示例 +- 实验新的编程概念 +- 分享最佳实践 + +随意添加各种示例代码! diff --git a/examples/hello.js b/examples/hello.js new file mode 100644 index 0000000..4b1422c --- /dev/null +++ b/examples/hello.js @@ -0,0 +1,30 @@ +#!/usr/bin/env node +/** + * 简单的 Hello World 示例 + * 这是一个基础的 JavaScript 程序示例 + */ + +/** + * 打招呼函数 + * @param {string} name - 要打招呼的名字 + * @returns {string} 问候语 + */ +function greet(name) { + return `你好, ${name}!`; +} + +/** + * 主函数 + */ +function main() { + console.log(greet("MonkeyCode")); + console.log("欢迎使用 MonkeyCode 练习项目!"); +} + +// 运行主函数 +main(); + +// 导出函数供测试使用 +if (typeof module !== 'undefined' && module.exports) { + module.exports = { greet }; +} diff --git a/examples/hello.py b/examples/hello.py new file mode 100644 index 0000000..c8f4042 --- /dev/null +++ b/examples/hello.py @@ -0,0 +1,27 @@ +#!/usr/bin/env python3 +""" +简单的 Hello World 示例 +这是一个基础的 Python 程序示例 +""" + +def greet(name): + """ + 打招呼函数 + + Args: + name (str): 要打招呼的名字 + + Returns: + str: 问候语 + """ + return f"你好, {name}!" + + +def main(): + """主函数""" + print(greet("MonkeyCode")) + print("欢迎使用 MonkeyCode 练习项目!") + + +if __name__ == "__main__": + main() diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..153a8df --- /dev/null +++ b/src/README.md @@ -0,0 +1,13 @@ +# 源代码目录 + +在此目录下放置你的源代码文件。 + +## 示例 + +你可以创建任何语言的源代码文件,例如: +- Python: `hello.py` +- JavaScript: `app.js` +- Java: `Main.java` +- Go: `main.go` + +随意实验和练习! diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..ecb16f4 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,13 @@ +# 测试代码目录 + +在此目录下放置你的测试代码文件。 + +## 示例 + +你可以为 `src/` 目录中的代码编写测试,例如: +- Python: `test_hello.py` +- JavaScript: `app.test.js` +- Java: `MainTest.java` +- Go: `main_test.go` + +练习编写单元测试和集成测试!