介绍
介绍
福哥今天要教给大家学会给自己的程序代码签名,签名的作用通常情况下是为了告诉使用我们的代码的人这个程序的原作者是谁。除此之外,签名还会把程序代码的版权协议告诉使用代码的人,不过在国内基本上除了特别出名的框架、插件、库会引起使用者的注意外,其他开源的程序代码基本没有人会在意版权问题~~
无论如何,给我们的程序代码增加签名,至少可以帮助我们的开源代码得到更好的推广作用。
结构
程序代码签名的基本结构就是项目名称、代码类型、代码名称、功能介绍以及一些作者信息相关的内容。
项目名称,程序代码一般都会所属某个项目,极少情况一个对象单独做为一个项目存在。
代码类型,注明我们的程序代码是个函数?还是一个对象?
代码名称,如果类型是函数这里就是函数名称,如果类型是对象这里就是对象名称
功能介绍,说明程序代码的主要功能以及在项目里的作用
作者信息,包括主页(link)、作者(author)、版权所有(copyright)、版本(version)、时间(datetime)、电子邮件(email)等等
PHP
对象签名
这是一段PHP程序的签名示例
/** * TFPHP * 类型: 对象 * 名称: TFRouter * 功能: 它是TFPHP框架的入口对象,所有请求进入TFPHP框架都要先通过TFRouter对象进行预处理 * 而后再进行路由映射 * * @link https://tongfu.net/tfphp/ * @copyright 2020 同福 * @author 同福 * @version 1.0.0 */ namespace TFPHP\System; class TFRouter{
Java
对象签名
这是一段Java程序的签名示例
/** * TFSpring * 类型: 对象 * 名称: TFJava * 功能: 它是TFSpring框架的核心对象,绝大部分的框架模块对象都依赖这个TFJava对象 * * @link https://tongfu.net/tfspring/ * @copyright 2020 同福 * @author 同福 * @version 1.0.0 */ package net.tongfu.tfspring.system; import org.springframework.web.context.request.RequestContextHolder; import org.springframework.web.context.request.ServletRequestAttributes; public class TFJava {
Python
对象签名
这是一段Python程序的签名示例
#coding=UTF-8 ########################################################################################################## # TFPython # 类型: 对象 # 名称: TFHttpClient # 功能: 这是一个HTTP客户端对象,基于urllib、urllib3库实现,用来发送HTTP协议的GET、POST请求,支持JSON格式数据 # # @link https://tongfu.net/tfpython/ # @copyright 2020 同福 # @author 同福 # @version 1.0.0 ########################################################################################################## import urllib import urllib3 import json class TFHttpClient:
总结
今天福哥带着童鞋们把程序代码的签名熟悉了一遍,相信童鞋们对签名已经有了自己的认识,在后面知道如何利用签名给自己的程序代码加上一层保护了~~