docs: 完善 GenerateCommand 的文档

This commit is contained in:
Luke 2025-06-24 11:32:23 +08:00
parent 9c5ae39ead
commit e0b4e2432f

View File

@ -13,31 +13,59 @@ import java.nio.file.Paths;
/** /**
* CLI 命令根据 project.cloud 生成项目目录结构 * CLI 命令根据 project.cloud 生成项目目录结构
* <p>
* 负责解析云项目描述文件并通过 {@link GenerateTask}
* INIT 生命周期阶段内生成基础目录结构
* </p>
* *
* <pre> * <pre>
* 用法示例
* $ snow generate * $ snow generate
* </pre> * </pre>
* *
* - 若当前目录不存在 project.cloud则提示先执行 snow init * <p>
* - 成功后会在控制台输出已创建的目录/文件列表 * 注意事项
* - 若当前目录不存在 project.cloud则提示用户先执行 `snow init`
* - 执行成功后会输出已创建的目录/文件
* </p>
*/ */
public final class GenerateCommand implements CLICommand { public final class GenerateCommand implements CLICommand {
/**
* 返回命令名称用于 CLI 调用
*
* @return 命令名称 "generate"
*/
@Override @Override
public String name() { public String name() {
return "generate"; return "generate";
} }
/**
* 返回命令简介用于 CLI 帮助或命令列表展示
*
* @return 命令描述字符串
*/
@Override @Override
public String description() { public String description() {
return "Generate project directory structure based on project.cloud."; return "Generate project directory structure based on project.cloud.";
} }
/**
* 打印命令用法信息
*/
@Override @Override
public void printUsage() { public void printUsage() {
System.out.println("Usage: snow generate"); System.out.println("Usage: snow generate");
} }
/**
* 执行生成任务
*
* @param args CLI 传入的参数数组此命令不接受参数
* @return 执行结果码0 表示成功1 表示 project.cloud 缺失
* @throws Exception 执行过程中出现错误时抛出
*/
@Override @Override
public int execute(String[] args) throws Exception { public int execute(String[] args) throws Exception {
Path dsl = Paths.get("project.cloud"); Path dsl = Paths.get("project.cloud");