需求
实际开发中,我们在创建类,Activity,或者Fragment时候会生成类的方法,或者注释,但是有些时候不是我们需要的,或者部分注释期望修改成我们所期望的格式,这样就需要对模板进行修改.
工程模板路径
工程模板有多个,这里只列举了常用了两个
- EmptyActivity
C:\MyPrograms\Android\as-3.2.1\AndroidStudio\plugins\android\lib\templates\activities\EmptyActivity
- BlankFragment
C:\MyPrograms\Android\as-3.2.1\AndroidStudio\plugins\android\lib\templates\other\BlankFragment
修改注释模板
这里以BlankFragment为例,也是我们常见的创建方式之一
1.找到BlankFragment文件夹下的 templas.xml文件
image.png
2.templas.xml作如下修改，修改前最好备份下原文件，以免修改错误无法恢复.
<?xml version="1.0"?>
<template
format="5"
revision="3"
name="Fragment (Blank)"
description="Creates a blank fragment that is compatible back to API level 4."
minApi="7"
minBuildApi="8">
<category value="Fragment" />
<dependency name="android-support-v4" revision="8" />
<parameter
id="className"
name="Fragment Name"
type="string"
constraints="class|nonempty|unique"
default="BlankFragment"
help="The name of the fragment class to create" />
<parameter
id="includeLayout"
name="Create layout XML?"
type="boolean"
default="true"
help="Generate a layout XML for the fragment" />
<parameter
id="fragmentName"
name="Fragment Layout Name"
type="string"
constraints="layout|nonempty|unique"
default="fragment_blank"
visibility="includeLayout"
suggest="fragment_${classToResource(className)}"
help="The name of the layout to create" />
<parameter
id="includeFactory"
name="Include fragment factory methods?"
type="boolean"
default="true"
help="Generate static fragment factory methods for easy instantiation" />
<parameter
id="includeCallbacks"
name="Include interface callbacks?"
type="boolean"
default="true"
help="Generate event callbacks for communication with an Activity or other fragments" />
<thumbs>
<thumb>template_blank_fragment.png</thumb>
</thumbs>
<globals file="globals.xml.ftl" />
<execute file="recipe.xml.ftl" />
</template>
3.找到BlankFragment.java.ftl文件
C:\MyPrograms\Android\as-3.2.1\AndroidStudio\plugins\android\lib\templates\other\BlankFragment\root\src\app_package
image.png
4.修改BlankFragment.java.ftl文件如下:
package ${packageName};
<#if includeCallbacks>import android.content.Context;</#if>
<#if includeCallbacks>import android.net.Uri;</#if>
import android.os.Bundle;
import ${getMaterialComponentName('android${SupportPackage}.app.Fragment', useAndroidX)};
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
<#if !includeLayout>import android.widget.TextView;</#if>
<#if applicationPackage??>
import ${applicationPackage}.R;
</#if>
/**
* A simple {@link Fragment} subclass.
<#if includeCallbacks>
* Activities that contain this fragment must implement the
* {@link ${className}.OnFragmentInteractionListener} interface
* to handle interaction events.
</#if>
<#if includeFactory>
* Use the {@link ${className}#newInstance} factory method to
* create an instance of this fragment.
</#if>
*
*/
public class ${className} extends Fragment {
<#if includeFactory>
// TODO: Rename parameter arguments, choose names that match
// the fragment initialization parameters, e.g. ARG_ITEM_NUMBER
private static final String ARG_PARAM1 = "param1";
private static final String ARG_PARAM2 = "param2";
// TODO: Rename and change types of parameters
private String mParam1;
private String mParam2;
</#if>
<#if includeCallbacks>
private OnFragmentInteractionListener mListener;
</#if>
<#if includeFactory>
/**
* Use this factory method to create a new instance of
* this fragment using the provided parameters.
*
* @param param1 Parameter 1.
* @param param2 Parameter 2.
* @return A new instance of fragment ${className}.
*/
// TODO: Rename and change types and number of parameters
public static ${className} newInstance(String param1, String param2) {
${className} fragment = new ${className}();
Bundle args = new Bundle();
args.putString(ARG_PARAM1, param1);
args.putString(ARG_PARAM2, param2);
fragment.setArguments(args);
return fragment;
}
</#if>
public ${className}() {
// Required empty public constructor
}
<#if includeFactory>
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
if (getArguments() != null) {
mParam1 = getArguments().getString(ARG_PARAM1);
mParam2 = getArguments().getString(ARG_PARAM2);
}
}
</#if>
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
<#if includeLayout>
// Inflate the layout for this fragment
return inflater.inflate(R.layout.${fragmentName}, container, false);
<#else>
TextView textView = new TextView(getActivity());
textView.setText(R.string.hello_blank_fragment);
return textView;
</#if>
}
<#if includeCallbacks>
// TODO: Rename method, update argument and hook method into UI event
public void onButtonPressed(Uri uri) {
if (mListener != null) {
mListener.onFragmentInteraction(uri);
}
}
@Override
public void onAttach(Context context) {
super.onAttach(context);
if (context instanceof OnFragmentInteractionListener) {
mListener = (OnFragmentInteractionListener) context;
} else {
throw new RuntimeException(context.toString()
+ " must implement OnFragmentInteractionListener");
}
}
@Override
public void onDetach() {
super.onDetach();
mListener = null;
}
/**
* This interface must be implemented by activities that contain this
* fragment to allow an interaction in this fragment to be communicated
* to the activity and potentially other fragments contained in that
* activity.
* <p>
* See the Android Training lesson <a href=
* "http://developer.android.com/training/basics/fragments/communicating.html"
* >Communicating with Other Fragments</a> for more information.
*/
public interface OnFragmentInteractionListener {
// TODO: Update argument type and name
void onFragmentInteraction(Uri uri);
}
</#if>
}
网友评论