如何爱上写项目、写好项目,不妨看看我的做法

开篇

爱上写项目真的很简单!在大学期间的我,其实不能说不爱写项目,但是总是写出屎山代码、写出自己都不愿维护的代码。我写过很多项目包括尚硅谷的、黑马的、微信小程序的、接单的。但是这些项目都有一些共同点!再次看它我不愿维护啊!当我项目越写越多,我会发现项目就像自己的孩子、自己的游戏角色,你要会打扮它,给它变强、变帅气,你才会越来越喜欢上它,就跟游戏一样,你也不喜欢你的游戏人物又丑又垃圾吧。

拥有并打扮一下自己的 Github

相信有很大部分人的 Github 是没有个人简介的、也没有头像。是个二维码头像,我以前也是这样,每次看见这个头像我都百感交集啊,我根本不想碰它。

我一开始荒废的 Github 是这样的:

image-20240510092457155.png

经过我打扮的 Github (https://github.com/lhccong):

image-20240510092548802.png
一个好的 Github 主页不仅能吸引面试官和小伙伴们的兴趣,还能提高自己的编程兴趣。每次看见自己的主页又能多一个项目、又多了 star 数、关注。心里对开发项目的兴趣又高了几分。

关于主页如何打扮,只需要创建一个跟自己名字一样的仓库,里面写一个 README.md 就可以显示在主页啦!是不是十分简单又便捷,至于具体的样式可以参考市面上优秀的作者:程序员鱼皮(鱼总🐟)直接 Copy 完事 随便改改参数。

给新项目取个好名字、搞个好图标

像我写项目有个习惯,我不喜欢一上来就开始写项目,我喜欢先配合 GPT 给我的项目取个好听的名字🔥,我经常是这样干的,比如说我的微狗、短链狗、SQL 慢镜 也是有问过 GPT 的意见。

至于好图标,我是通过鱼聪明(https://www.yucongming.com/app/draw)生成的,之前白嫖到的鱼毛来进行图标生成,给大家看看我的几个图标吧。

在这里插入图片描述
在这里插入图片描述

好的图标能让别人更加的对你的项目好奇,也会提高你自己的兴趣喔。

将大提交改成小提交

这句话是什么意思呢,之前的我是每次写完一大堆代码,再一次性提交上去。这样的写法会导致项目十分难以维护,你根本都不知道自己一大段提交做了什么,到后面你自己的代码就不想看了,我的做法是什么呢?我将每次的小功能、小代码都弄成一次提交,最后统一的进行 push ,这样当你自己或者别人查看你的代码时,都会清楚明白你这次改动做了什么。举个例子:就好像我前段时间学习的 yu-rpc,我自己的提交就有一百多次。

image-20240510094446449.png

我经常用的提交格式: 新增功能时用 feat 、 修改代码时用 fix 、修改、新增文档时用 docs

给代码穿好衣服

相信大家也是很讨厌写注释,但是写注释不仅能让别人能懂你的代码,更重要是自己在阅读代码的时候能更好的快速回顾自己的代码是干了什么,能帮助自己快速的维护,现在都是 AI 时代,我自己写代码的时候对于普通的代码我都会使用 AI(CodeGeex)来进行注释生成、比较特殊的代码我会自己进行注释修改。

image-20240510095442156.png

不要忽略提交预警

相信大家在提交的时候会看见自己的代码有很多黄色波浪线、提交的时候还会弹出框来预警:

image-20240510095626960.png

我推荐大家先尝试将这些预警修复,每当我看见一个项目有十分多黄色波浪线时,我的代码强迫症就会出现(现实我是没有强迫症的),现在的我总喜欢一个一个将黄色修复,这样下次写起来也会让自己的代码更加规范、更加美观。

不妨写个好看的 README.md

一个好看的项目介绍文档能吸引别人注意力、能让人家更想了解你的项目。可以参考别人开源项目的 README.md 直接 Copy!稍作修改就能成为自己项目的介绍啦~大家可以赶快去上手试一下,在介绍中可以加入自己的项目截图、项目技术栈喔,附上我的一个项目介绍:

在这里插入图片描述

学习好项目

我现在比较喜欢学习别人的优秀项目,比如 Sa-Token 、MyBatis、JustAuth ,参考着市面上的开源项目我也写出了:

1)SQL 慢镜:https://github.com/lhccong/sql-slow-mirror

2)OneAuth:https://github.com/lhccong/OneAuth

3)Switch-HTTP:https://github.com/lhccong/switch-http

4)AsyncX:https://github.com/lhccong/AsyncX

觉得写的还不错的代码可以给我一个免费的小星星⭐⭐喔

那这些项目都从哪发现的呢?我有以下几个渠道:

1)直接 Github 上搜索 Java 项目高 Star 的开源项目。

2)在 Gitee 上有一个 GVP 项目,最有价值开源项目选择 Java 类型的来学习。

3)查看技术博主推的一些开源学习项目。

坚持自己的知识输出

当我每次发帖子都会发现,我不仅分享了知识,我还加深了自己对知识的理解,对于知识的加深更加提高了我对代码的喜欢,我喜欢在星球上分享自己学习到的知识、在掘金、CSDN 有时也会一起分享,看到大家给我点赞也能满足自己的一点小小虚荣心吧哈哈哈。

给大家分享下我的掘金跟 CSDN

掘金🛫:https://juejin.cn/user/1146154496301956/posts

CSDN🔥:https://blog.csdn.net/LHCong_

以上就是我的分享啦~感谢大家看到最后,我是聪ζ希望可以跟大家一起学习,我的 Github:https://github.com/lhccong,如果里面有你感兴趣的项目不妨给我点个星星⭐和关注🔥,未来我还会持续写新的好玩的小项目。

相关推荐

  1. 如何SQL

    2024-05-11 10:06:03       12 阅读
  2. 一个标准项目说明书大纲

    2024-05-11 10:06:03       6 阅读
  3. 如何PPT报告

    2024-05-11 10:06:03       53 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-05-11 10:06:03       16 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-05-11 10:06:03       16 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-05-11 10:06:03       15 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-05-11 10:06:03       18 阅读

热门阅读

  1. 什么是中间件

    2024-05-11 10:06:03       8 阅读
  2. 关于SpringBoot MVC接口超时时间的分析

    2024-05-11 10:06:03       12 阅读
  3. C#爬虫爬取某东商品信息

    2024-05-11 10:06:03       9 阅读
  4. TVM简介

    TVM简介

    2024-05-11 10:06:03      10 阅读
  5. Lua(0)环境搭建与基础代码

    2024-05-11 10:06:03       13 阅读
  6. GraphQL在现代Web应用中的应用与优势

    2024-05-11 10:06:03       12 阅读
  7. 线程池+日志

    2024-05-11 10:06:03       9 阅读
  8. ASE docker related research

    2024-05-11 10:06:03       13 阅读