?? documenter.html
字號:
<FONT color="green">125</FONT> System.out.println("]]></see>");<a name="line.125"></a>
<FONT color="green">126</FONT> } else<a name="line.126"></a>
<FONT color="green">127</FONT> System.out.println(" />");<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> private void documentSee(Doc doc) {<a name="line.130"></a>
<FONT color="green">131</FONT> // create sees: <see [type|member]="...">...</see> ...<a name="line.131"></a>
<FONT color="green">132</FONT> SeeTag[] tags = doc.seeTags();<a name="line.132"></a>
<FONT color="green">133</FONT> for (int i = 0; i < tags.length; ++i) {<a name="line.133"></a>
<FONT color="green">134</FONT> // open the see: <see reference="..."<a name="line.134"></a>
<FONT color="green">135</FONT> // [type="class|interface|constructor|method|field"]><a name="line.135"></a>
<FONT color="green">136</FONT> System.out.print("<see ");<a name="line.136"></a>
<FONT color="green">137</FONT> documentLink(tags[i]);<a name="line.137"></a>
<FONT color="green">138</FONT> // close the see, optionallly with content: </see><a name="line.138"></a>
<FONT color="green">139</FONT> documentSee(tags[i].label());<a name="line.139"></a>
<FONT color="green">140</FONT> }<a name="line.140"></a>
<FONT color="green">141</FONT> }<a name="line.141"></a>
<FONT color="green">142</FONT> <a name="line.142"></a>
<FONT color="green">143</FONT> private void document(Doc doc) {<a name="line.143"></a>
<FONT color="green">144</FONT> // create an element with the raw comment source<a name="line.144"></a>
<FONT color="green">145</FONT> System.out.print("<description><![CDATA[");<a name="line.145"></a>
<FONT color="green">146</FONT> documentText(doc.inlineTags());<a name="line.146"></a>
<FONT color="green">147</FONT> System.out.println("]]></description>");<a name="line.147"></a>
<FONT color="green">148</FONT> documentSee(doc);<a name="line.148"></a>
<FONT color="green">149</FONT> }<a name="line.149"></a>
<FONT color="green">150</FONT> <a name="line.150"></a>
<FONT color="green">151</FONT> private Member getMember(String name, Member[] members) {<a name="line.151"></a>
<FONT color="green">152</FONT> // find a member with the same name (TODO: match signatures)<a name="line.152"></a>
<FONT color="green">153</FONT> for (int i = 0; i < members.length; ++i)<a name="line.153"></a>
<FONT color="green">154</FONT> if (name.equals(members[i].getName()))<a name="line.154"></a>
<FONT color="green">155</FONT> return members[i];<a name="line.155"></a>
<FONT color="green">156</FONT> return null;<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
<FONT color="green">158</FONT> <a name="line.158"></a>
<FONT color="green">159</FONT> private void documentType(Type type) {<a name="line.159"></a>
<FONT color="green">160</FONT> // print the textual representation of the type<a name="line.160"></a>
<FONT color="green">161</FONT> String name = type.qualifiedTypeName();<a name="line.161"></a>
<FONT color="green">162</FONT> // count the dimensions for an array<a name="line.162"></a>
<FONT color="green">163</FONT> int dimension = 0;<a name="line.163"></a>
<FONT color="green">164</FONT> String dimensions = type.dimension();<a name="line.164"></a>
<FONT color="green">165</FONT> for (int bracket = dimensions.indexOf('['); bracket >= 0; bracket = dimensions<a name="line.165"></a>
<FONT color="green">166</FONT> .indexOf('[', bracket + 1))<a name="line.166"></a>
<FONT color="green">167</FONT> ++dimension;<a name="line.167"></a>
<FONT color="green">168</FONT> // print the type information: type="..." [dimension="..."]<a name="line.168"></a>
<FONT color="green">169</FONT> System.out.print(" type=\"" + Processor.translateName(name) + "\"");<a name="line.169"></a>
<FONT color="green">170</FONT> if (dimension != 0)<a name="line.170"></a>
<FONT color="green">171</FONT> System.out.print(" dimension=\"" + String.valueOf(dimension) + "\"");<a name="line.171"></a>
<FONT color="green">172</FONT> }<a name="line.172"></a>
<FONT color="green">173</FONT> <a name="line.173"></a>
<FONT color="green">174</FONT> private void documentParameter(Parameter parameter, ParamTag tag) {<a name="line.174"></a>
<FONT color="green">175</FONT> // open the parameter: <parameter name="..." type="..." [dimension="..."]><a name="line.175"></a>
<FONT color="green">176</FONT> System.out.print("<parameter name=\"" + parameter.name() + "\"");<a name="line.176"></a>
<FONT color="green">177</FONT> documentType(parameter.type());<a name="line.177"></a>
<FONT color="green">178</FONT> System.out.print("><![CDATA[");<a name="line.178"></a>
<FONT color="green">179</FONT> System.out.print(tag.parameterComment());<a name="line.179"></a>
<FONT color="green">180</FONT> // close the parameter: </parameter><a name="line.180"></a>
<FONT color="green">181</FONT> System.out.println("]]></parameter>");<a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> <a name="line.183"></a>
<FONT color="green">184</FONT> private void documentParameter(Parameter parameter) {<a name="line.184"></a>
<FONT color="green">185</FONT> // create the undocumented parameter:<a name="line.185"></a>
<FONT color="green">186</FONT> // <parameter name="..." type="..." [dimension="..."] /><a name="line.186"></a>
<FONT color="green">187</FONT> System.out.print("<parameter name=\"" + parameter.name() + "\"");<a name="line.187"></a>
<FONT color="green">188</FONT> documentType(parameter.type());<a name="line.188"></a>
<FONT color="green">189</FONT> System.out.println(" />");<a name="line.189"></a>
<FONT color="green">190</FONT> }<a name="line.190"></a>
<FONT color="green">191</FONT> <a name="line.191"></a>
<FONT color="green">192</FONT> private void documentParameters(ExecutableMemberDoc doc) {<a name="line.192"></a>
<FONT color="green">193</FONT> // create parameters:<a name="line.193"></a>
<FONT color="green">194</FONT> // <parameter name="..." type="..." [dimension="..."]>...</parameter> ...<a name="line.194"></a>
<FONT color="green">195</FONT> Parameter[] parameters = doc.parameters();<a name="line.195"></a>
<FONT color="green">196</FONT> ParamTag[] tags = doc.paramTags();<a name="line.196"></a>
<FONT color="green">197</FONT> for (int i = 0; i < parameters.length; ++i) {<a name="line.197"></a>
<FONT color="green">198</FONT> String name = parameters[i].name();<a name="line.198"></a>
<FONT color="green">199</FONT> boolean found = false;<a name="line.199"></a>
<FONT color="green">200</FONT> // try to document a parameter<a name="line.200"></a>
<FONT color="green">201</FONT> for (int j = 0; j < tags.length; ++j)<a name="line.201"></a>
<FONT color="green">202</FONT> if (name.equals(tags[j].parameterName())) {<a name="line.202"></a>
<FONT color="green">203</FONT> documentParameter(parameters[i], tags[j]);<a name="line.203"></a>
<FONT color="green">204</FONT> found = true;<a name="line.204"></a>
<FONT color="green">205</FONT> break;<a name="line.205"></a>
<FONT color="green">206</FONT> }<a name="line.206"></a>
<FONT color="green">207</FONT> // mention an undocumented parameter<a name="line.207"></a>
<FONT color="green">208</FONT> if (!found)<a name="line.208"></a>
<FONT color="green">209</FONT> documentParameter(parameters[i]);<a name="line.209"></a>
<FONT color="green">210</FONT> }<a name="line.210"></a>
<FONT color="green">211</FONT> }<a name="line.211"></a>
<FONT color="green">212</FONT> <a name="line.212"></a>
<FONT color="green">213</FONT> private void documentException(ThrowsTag tag) {<a name="line.213"></a>
<FONT color="green">214</FONT> // open the exception: <exception type="..."><a name="line.214"></a>
<FONT color="green">215</FONT> System.out.print("<exception type=\"" + tag.exception().qualifiedTypeName()<a name="line.215"></a>
<FONT color="green">216</FONT> + "\"><![CDATA[");<a name="line.216"></a>
<FONT color="green">217</FONT> System.out.print(tag.exceptionComment());<a name="line.217"></a>
<FONT color="green">218</FONT> // close the exception: </exception><a name="line.218"></a>
<FONT color="green">219</FONT> System.out.println("]]></exception>");<a name="line.219"></a>
<FONT color="green">220</FONT> }<a name="line.220"></a>
<FONT color="green">221</FONT> <a name="line.221"></a>
<FONT color="green">222</FONT> private void documentException(String name) {<a name="line.222"></a>
<FONT color="green">223</FONT> // create the undocumented exception: <exception name="..." /><a name="line.223"></a>
<FONT color="green">224</FONT> System.out.println("<exception type=\"" + name + "\" />");<a name="line.224"></a>
<FONT color="green">225</FONT> }<a name="line.225"></a>
<FONT color="green">226</FONT> <a name="line.226"></a>
<FONT color="green">227</FONT> private void documentExceptions(ExecutableMemberDoc doc) {<a name="line.227"></a>
<FONT color="green">228</FONT> // create exceptions: <exception type="...">...</exception> ...<a name="line.228"></a>
<FONT color="green">229</FONT> ClassDoc[] exceptions = doc.thrownExceptions();<a name="line.229"></a>
<FONT color="green">230</FONT> ThrowsTag[] tags = doc.throwsTags();<a name="line.230"></a>
<FONT color="green">231</FONT> for (int i = 0; i < exceptions.length; ++i) {<a name="line.231"></a>
<FONT color="green">232</FONT> String name = exceptions[i].qualifiedTypeName();<a name="line.232"></a>
<FONT color="green">233</FONT> boolean found = false;<a name="line.233"></a>
<FONT color="green">234</FONT> // try to document an exception<a name="line.234"></a>
<FONT color="green">235</FONT> for (int j = 0; j < tags.length; ++j)<a name="line.235"></a>
<FONT color="green">236</FONT> if (name.equals(tags[j].exceptionName())) {<a name="line.236"></a>
<FONT color="green">237</FONT> documentException(tags[j]);<a name="line.237"></a>
<FONT color="green">238</FONT> found = true;<a name="line.238"></a>
<FONT color="green">239</FONT> }<a name="line.239"></a>
<FONT color="green">240</FONT> // mention an undocumented exception<a name="line.240"></a>
<FONT color="green">241</FONT> if (!found)<a name="line.241"></a>
<FONT color="green">242</FONT> documentException(name);<a name="line.242"></a>
<FONT color="green">243</FONT> }<a name="line.243"></a>
<FONT color="green">244</FONT> }<a name="line.244"></a>
<FONT color="green">245</FONT> <a name="line.245"></a>
<FONT color="green">246</FONT> private void documentReturns(MethodDoc doc) {<a name="line.246"></a>
<FONT color="green">247</FONT> // create a non-void documented returns: <returns>...</returns><a name="line.247"></a>
<FONT color="green">248</FONT> Type returns = doc.returnType();<a name="line.248"></a>
<FONT color="green">249</FONT> if (!returns.typeName().equals("void")) {<a name="line.249"></a>
<FONT color="green">250</FONT> // open the returns: <returns type="..." [dimension="..."]<a name="line.250"></a>
<FONT color="green">251</FONT> System.out.print("<returns");<a name="line.251"></a>
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -